Abit/CONTRIBUTING.md

1.0 KiB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or another method with the owners of this repository before making a change.

Make sure Abit is the right place for the change - changes on the protocol level might be better placed in Jabit.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. A pull request should always merge into develop; only releases are merged into master.
  4. A reviewer usually merges the pull requests. They may however request you to do it in case you have sufficient permissions, or may request you to update your branch to include the latest changes from develop.