dothub welcomes contribution, specially if they address any of the existing issues or are "generic" improvements like code coverage, documentation or style issues.
For any bug report or question, please use the issue tracker.
If it is your first contribution to an opensource project you are encouraged to take the simplest change possible. From fixing a typo, raising the coverage, improve documentaion or any other trivialtask you might spot. This helps you set up the environment and get ready for the "real stuff".
If you feel curage enough, check the github issues open for collaborators.
Feeling totally bored and hopeless in life? If you have sent a couple of Pull Request and want to get deeper in the project just send a mail.
Be sure to include tests that verify the change. All tests should have an human redable docstring that explains what is being tested or validate. Please, no tests just to raise the coverage.
If the change is implementing a new feature be sure to have some integration tests covering it as well.
The code has two kind of test levels:
- unit: Quick to write, validate "happy paths" and corner cases of each piece of code. One suite of tests per Python module. These suites make assumptions about the HTTP responses are.
- end to end: Tests against the real github with a fake organization.
If any check in the Pull Request fails, the chances of your pull request getting merged are really low.
Contributions are welcomed. Just follow the same style and common sense
make testmake release