|
| 1 | +How to contribute to Tessera / install-emr |
| 2 | +========================================== |
| 3 | + |
| 4 | +Thank you for sharing your code with the Tessera project. We appreciate your contribution! |
| 5 | + |
| 6 | +## Join the developer mailing list |
| 7 | + |
| 8 | +If you're not already on the Tessera developers list, take a minute to join. This is as easy as sending an email to [email protected]. |
| 9 | +It would be great if you'd introduce yourself to the group but it's not required. You can just let your code do the talking for you if you like. |
| 10 | + |
| 11 | +## Check the issue tracker |
| 12 | + |
| 13 | +Before you write too much code, check the [open issues in the install-emr issue tracker](https://github.com/tesseradata/install-emr/issues?state=open) |
| 14 | +to see if someone else has already filed an issue related to your work or is already working on it. If not, go ahead and |
| 15 | +[open a new issue](https://github.com/tesseradata/install-emr/issues/new). |
| 16 | + |
| 17 | +## Announce your work on the mailing list |
| 18 | + |
| 19 | +Shoot us a quick email on the mailing list letting us know what you're working on. There |
| 20 | +will likely be people on the list who can give you tips about where to find relevant |
| 21 | +source or alert you to other planned changes that might effect your work. |
| 22 | + |
| 23 | +## Submit your pull request |
| 24 | + |
| 25 | +Github provides a nice [overview on how to create a pull request](https://help.github.com/articles/creating-a-pull-request). |
| 26 | + |
| 27 | +Some general rules to follow: |
| 28 | + |
| 29 | +* Do your work in [a fork](https://help.github.com/articles/fork-a-repo) of the install-emr repo. |
| 30 | +* Create a branch for each feature/bug in install-emr that you're working on. These branches are often called "feature" |
| 31 | +or "topic" branches. |
| 32 | +* Use your feature branch in the pull request. Any changes that you push to your feature branch will automatically |
| 33 | +be shown in the pull request. If your feature branch is not based off the latest master, you will be asked to rebase |
| 34 | +it before it is merged. |
| 35 | +* If your pull request fixes an issue, reference the issue so that it will [be closed when your pull request is merged](https://github.com/blog/1506-closing-issues-via-pull-requests) |
| 36 | +* Keep your pull requests as small as possible. Large pull requests are hard to review. Try to break up your changes |
| 37 | +into self-contained and incremental pull requests, if need be, and reference dependent pull requests, e.g. "This pull |
| 38 | +request builds on request #92. Please review #92 first." |
| 39 | +* The first line of commit messages should be a short (<80 character) summary, followed by an empty line and then, |
| 40 | +optionally, any details that you want to share about the commit. |
0 commit comments