Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

19 lines (15 loc) · 1.31 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue 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. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Ensure that no newly created warnings where generated by SwiftLint in the process of building the project.
  3. Test that your code compiles using all dependency managers that are integrated into the project (for example: CocoaPods / Carthage / Swift Package Manager).
  4. In case of a newly created entry preset, please update the example project preset screen by adding an example.
  5. Update the README.md and the CHANGELOG.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  6. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  7. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.