summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-02-01 22:24:43 +0000
committerKarl Berry <karl@freefriends.org>2019-02-01 22:24:43 +0000
commit805981bbd523e8de0f52342e707cdee1318bff24 (patch)
tree8d07dc0e763ac70cd2b5215b146499d3d36e73e6 /Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md
parent6f86b3a71f98c77e43aead443cc3faf8b4c27909 (diff)
europecv (1feb19)
git-svn-id: svn://tug.org/texlive/trunk@49902 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md')
-rw-r--r--Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md b/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md
new file mode 100644
index 00000000000..fd2ebb98812
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/europecv/CONTRIBUTING.md
@@ -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.
+