Skip to content

Commit 618e811

Browse files
authored
Update CONTRIBUTING.md to include our release process (#293)
* include our release process (#293)
1 parent 4078f6f commit 618e811

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ and we would be happy to set you up.
1111
- [How to contribute](#how-to-contribute)
1212
- [Coding conventions](#coding-conventions)
1313
- [Submitting a pull request](#submitting-a-pull-request)
14+
- [Release Process](#release-process)
1415
- [Code of Conduct](#code-of-conduct)
1516
- [License](#license)
1617

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

49+
## Release Process
50+
**NOTE: The default branch `@develop` is not guaranteed to be stable and you should always use published release versions in your testing and production.**
51+
52+
- 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.
53+
- We checkout a pre-release branch to prepare for an upcoming release.
54+
- We perform additional manual and automated tests in this branch to make sure there are no regressions.
55+
- Once we are ready we tag the head of our release branch and perform a release on it.
56+
- Tagged releases are published as actions and they are the most suitable to be used in production.
57+
58+
4859
## Code of Conduct
4960
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.
5061

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

0 commit comments

Comments
 (0)