Skip to content

Instantly share code, notes, and snippets.

@rakeshchoyal92

rakeshchoyal92/contribution.md

Created June 26, 2019 01:45
Show Gist options
  • Save rakeshchoyal92/3e1b3bd4cd2c9463450cd7d35c2792e9 to your computer and use it in GitHub Desktop.
Save rakeshchoyal92/3e1b3bd4cd2c9463450cd7d35c2792e9 to your computer and use it in GitHub Desktop.
Download ZIP
Welcome file
Raw
contribution.md

Contribution

When contributing to this repository, please adhere to the below guidelines.

  • Create an issue
  • Pre-push changes
  • Commit message format
  • Pull request process

Create an issue

  • Before pushing code to the repo, it is required to create an issue along with a brief description so that other developers can comment, provide suggestions and feedback

Pre-push changes

Before pushing the code to repo please make sure to:

  1. Update the README.md with details of changes to the interface, this includes the new environment variables, exposed ports, useful file locations and container parameters
  2. 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 (would like to) use is SemVer

Commit message format

  • Commit message should be of the following format [ISSSUE_NO] COMMIT_MESSAGE You can obtain ISSUE_NO from issue information

Pull Request Process

Please note that you cannot push directly to develop/master branch.

  • Create a new branch and push the changes to this branch
  • Create a PR and add at least one reviewer
  • You may merge the Pull Request in once you have the sign-off of any other developer, or if you do not have permission to do that, you may request the reviewer to merge it for you
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment