We the maintainers solemnly swear to be good people and not shoot you down.
- Pull request and commit messages should be descriptive.
- Reference relevant issue(s) if there are any.
- Be PEP8 Compliant as best as you can.
- Write custom exceptions for the noobs.
- Make changes and pull requests from non-master branches.
- Write any documentation if the changes you've made require it.
- Don't be messy with the code.
- Add comments as you see fit.
- Tag issues with the appropriate label (bug/enhancement...)
- Check if the issue exists before making a new one.
- Be detailed in bug reports.
- Feature requests should explain why the feature would help.
- Check if you've actually found a bug or you just didn't follow the install instructions before submitting a bug report.
-
Find an issue that you are interested in addressing or a feature that you would like to add.
-
Fork the repository. This means that you will have a copy of the repository under your-GitHub-username/uds.
-
Clone the repository to your local machine using
$ git clone https://github.com/stewartmcgown/uds.git. -
Create a new branch for your fix using
$ git checkout -b [name your branch]. -
Code, Commit, Pull Request
-
Maintainers will review the request and may ask you to update it.
-
Once you've made the changes requested, your request will be merged.