We welcome improvements to autoscrub!
- Log an bug/enhancement on the GitHub issue tracker. For enhancements, we encourage discussion of the enhancement before beginning coding (this is not a strict requirement, but it may result in a faster review process)
- Fork the repository on GitHub (this requires a GitHub account).
- Make the modifications
- For small modifications, commit to the default branch in your forked repository
- For large changes (such as new features) commit your changes to a new branch in your forked repository
- Test your changes and make sure they are complete and you have not introduced any regressions (ensure your changes pass any automated tests we provide)
- Update the documentation in the "docs" folder to make it consistent with your changes.
- Complete either the individual or entity agreement
- Using the GitHub web interface for your forked repository, make a pull-request to the main autoscrub repository and attach the agreement completed in step 7. In the description of the pull request, include the text "fixes issue #num" where "num" is replaced by the issue number for the issue you logged in step 1.
- We will review your pull-request, and may request changes to your code.
- Once we are happy with the pull-request, we will merge in your changes.