Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.54 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. Squash all your commits before opening the PR.
  2. Ensure you're pull-request contains a unique commit referencing the issue that solves in the commit message. Example: Implement new features #7.
  3. Ensure that you run SwiftFormat and SwiftLint.
  4. 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.

Deployment

  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. 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.
  4. Increase the version number to .github_changelog_generator file.
  5. Run github_changelog_generator -u didix21 -p Shusky.
  6. Commit your changes with the message: Bumped to version .
  7. Go to github and create a new release.