| .. _contributing: |
| |
| Contributing to UserAle.pyqt5 |
| ----------------------------- |
| |
| Thank you for contributing to the UserAle project! |
| |
| There are certain procedures that must be followed for all contributions. These |
| procedures are necessary to allow us to allocate resources for reviewing and |
| testing your contribution, as well as communicate effectively with you during |
| the review process. |
| |
| 1) Create an issue in GitHub |
| |
| All changes to UserAle must have corresponding issues in GitHub so the |
| change can be properly tracked: |
| |
| https://github.com/draperlaboratory/userale.pyqt5/issues |
| |
| If you do not already have an account on GitHub, you will need to create |
| before creating your new issue. |
| |
| 2) Make and test your changes locally |
| |
| The UserAle source is maintained in a git repository hosted on GitHub: |
| |
| https://github.com/draperlaboratory/userale.pyqt5 |
| |
| To make your changes, fork the repository and make commits |
| to a topic branch in your fork. Commits should be made in logical units |
| and must reference the Git issue number: |
| |
| :: |
| |
| $ git commit -m "UserAle-123: High-level message describing the changes." |
| |
| Avoid commits which cover multiple, distinct goals that could (and should) |
| be handled separately. |
| |
| If you do not already have an account on GitHub, you will need to create |
| one before making your changes. |
| |
| 3) Submit your changes via a pull request on GitHub |
| |
| Once your changes are ready, submit them by creating a pull request for |
| the corresponding topic branch you created when you began working on your |
| changes. |
| |
| The UserAle team will then review your changes and, if they pass review, |
| your changes will be merged. |