This is intended for developers wishing to contribute code to the project.
A branch must be created in order to contribute code to the project. Unless you have permissions to create branches in Amulet-Team you will first need to fork the repository. You must then create a branch with an identifiable name using the following convention:
- For features, use:
impl-<feature name> - For bug fixes, use:
bug-<bug tracker ID> - For improvements/rewrites, use:
improv-<feature name> - For prototyping, use:
proto-<feature name>
There are a number of tests to make sure that the code behaves correctly. If you are making changes to the code these should be run before creating the pull request.
For code formatting, we use the formatting utility black.
To run it on a file, run the following command from your favorite terminal after installing: black <path to file>
While formatting is not strictly required for each commit, we ask that after you've finished your code changes for your Pull Request to run it on every changed file.
The following command will run it on all files. black .
Once you have added the desired changes and run tests and formatting you will need to create a pull request. We ask that submitted Pull Requests give moderately detailed notes about the changes and explain any changes that were made to the program outside of those directly related to the feature/bug-fix.
Once a Pull Request is submitted, we will mark the request for review. Once that is done, we will review the changes and may provide feedback on things to change. Once all additional changes have been made, we will merge the request.
The tests and code formatting will be run automatically when the pull request is created to verify that everything is okay. This can be seen at the bottom of the pull request page.