Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 2.34 KB

Contributing

For general contribution and community guidelines, please see the community repo.

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!

Releasing

Releases should be created by maintainers only. To create and promote a release, follow the instructions in this section.

Update the changelog and notices

NOTE: If the Changelog and NOTICES.txt are already up-to-date, skip this step and promote the desired build from the master branch.

  1. Create a new branch for the version bump.
  2. Based on the changelog content, determine the new version number and update.
  3. Review the git log and ensure the changelog contains all relevant recent changes with references to GitHub issues or PRs, if possible.
  4. Review the changes since the last tag, and if the dependencies have changed revise the NOTICES to correctly capture the included dependencies and their licenses / copyrights.
  5. Commit these changes - Bump version to x.y.z is an acceptable commit message - and open a PR for review.

Release and Promote

  1. Merging into the master branch will automatically trigger a release. If successful, this release can be promoted at a later time.
  2. Jenkins build parameters can be utilized to promote a successful release or manually trigger aditional releases as needed.
  3. Reference the internal automated release doc for releasing and promoting.