When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- Make sure you have created tests for your new feature (if possible). Also run all existing tests to prevent breaking changes.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the current documentation and README.md with details of changes to the interface, this includes new environment variables, useful file locations and container parameters. Also update the requirements.txt if necessary.
- There is an attempt to aim for the SemVer version system.
Additionally, you can find a list of plans for the future of
GraphDonkey
in the README.md. Figure out which version your PR can be a part of and change the corresponding values (mainlymain.extra.Constants.APP_VERSION
). PRs that do not take the future features into account will not be merged. - Only PRs with valid file formatting will be accepted.