Skip to content

Files

Latest commit

4c0961a · Jan 16, 2020

History

History
24 lines (20 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

24 lines (20 loc) · 1.28 KB

Contributing

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.

Pull Request Process

  1. Make sure you have created tests for your new feature (if possible). Also run all existing tests to prevent breaking changes.
  2. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  3. 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.
  4. 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 (mainly main.extra.Constants.APP_VERSION). PRs that do not take the future features into account will not be merged.
  5. Only PRs with valid file formatting will be accepted.