diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/europecv/CONTRIBUTING.md |
Initial commit
Diffstat (limited to 'macros/latex/contrib/europecv/CONTRIBUTING.md')
-rw-r--r-- | macros/latex/contrib/europecv/CONTRIBUTING.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/macros/latex/contrib/europecv/CONTRIBUTING.md b/macros/latex/contrib/europecv/CONTRIBUTING.md new file mode 100644 index 0000000000..1b8e73d7c2 --- /dev/null +++ b/macros/latex/contrib/europecv/CONTRIBUTING.md @@ -0,0 +1,50 @@ +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)). + +## Working on your first Pull Request? + +You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) + +## 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. + |