-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/master'
- Loading branch information
Showing
2 changed files
with
49 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
Contributing | ||
============ | ||
|
||
👍🎉 Thanks a lot for considering contributing 🎉👍 | ||
|
||
We welcome and encourage contribution. There is many way to contribute: you can | ||
write bug report, contribute code or documentation (take a look at the | ||
[Wiki section](https://github.com/gsilano/EuropeCV/wiki)). | ||
|
||
## Reporting issues | ||
|
||
When reporting issues the more information you can supply the better. | ||
|
||
If it is an issue with building the LaTeX package, indicate your environment like operating system and, | ||
version of MikTeX your are using. | ||
|
||
## Improvements request and proposal | ||
|
||
Feel free to make an issue to request a new functionality. | ||
|
||
## Contributing code/Pull-Request | ||
|
||
We welcome contribution, this can be done by starting a pull-request. | ||
You can contribute by updating the package content or styling, code (.cls file), or both. | ||
|
||
### Contributing content or styling | ||
|
||
There is a couple of basic requirement for us to merge the pull request: | ||
- The styling should maintain the compatibility with previous versions. For example, if you plan to | ||
add a new number to the contact information, it should be optional and not mandatory allowing not to | ||
change anything to the other users of the package. | ||
|
||
### Contributing code | ||
|
||
If the change is big, typically if the change span to more than one file, consider starting an issue first to discuss the improvement. | ||
This will makes it much easier to make the change fit well into the package. | ||
|
||
There is some basic requirement for us to merge a pull request: | ||
- Describe the change (a bot will remind you in case you forget it) | ||
- Refer to any issues it effects | ||
- Separate one pull request per functionality: if you start writing "and" in the feature description consider if it could be | ||
separated in two pull requests. | ||
|
||
In your code: | ||
- Make sure the coding style of your code follows the style of the file. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters