Skip to content

Commit

Permalink
Update CONTRIBUTING.md to include our release process (#293)
Browse files Browse the repository at this point in the history
* include our release process (#293)
  • Loading branch information
motatoes authored May 24, 2023
1 parent 4078f6f commit 618e811
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ and we would be happy to set you up.
- [How to contribute](#how-to-contribute)
- [Coding conventions](#coding-conventions)
- [Submitting a pull request](#submitting-a-pull-request)
- [Release Process](#release-process)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

Expand Down Expand Up @@ -45,8 +46,18 @@ When you have made changes to the codebase that you would like to contribute bac
5. Submit a pull request to the `main` branch.
We will review your pull request as soon as possible. Please be patient and open to feedback. We appreciate your contributions!

## Release Process
**NOTE: The default branch `@develop` is not guaranteed to be stable and you should always use published release versions in your testing and production.**

- All pull requests are merged to the default develop branch after initial unit tests and integration tests are passing and required code review requirements are met.
- We checkout a pre-release branch to prepare for an upcoming release.
- We perform additional manual and automated tests in this branch to make sure there are no regressions.
- Once we are ready we tag the head of our release branch and perform a release on it.
- Tagged releases are published as actions and they are the most suitable to be used in production.


## Code of Conduct
We expect all contributors to follow our [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) when participating in our community. Please read it carefully before contributing.

## License
Digger is released under the [Apache License](LICENSE). By contributing to this project, you agree to license your contributions under the same license.
Digger is released under the [Apache License](LICENSE). By contributing to this project, you agree to license your contributions under the same license.

0 comments on commit 618e811

Please sign in to comment.