status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

[NET-8953] docs: add backport policy section to CONTRIBUTING (#21252) 

docs: add backport policy section to CONTRIBUTING

Add detail about Consul's backport policy w.r.t. LTS/CE.

Also update label docs and remove defunct redirect .md files.
This commit is contained in:
Michael Zalimeni 2024-06-04 12:46:20 -04:00 committed by GitHub
parent 4edf369313
commit d3ad840d8c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored
View File

@ -156,13 +156,16 @@ When you're ready to submit a pull request:
5. If there's any reason Consul users might need to know about this change, 5. If there's any reason Consul users might need to know about this change,
[add a changelog entry](../docs/contributing/add-a-changelog-entry.md). [add a changelog entry](../docs/contributing/add-a-changelog-entry.md).
6. Add labels to your pull request. A table of commonly use labels is below. 6. Add labels to your pull request. A table of commonly use labels is below.
If you have any questions about which to apply, feel free to call it out in the PR or comments. If you have any questions about which to apply, feel free to call it out in the PR or comments. Other labels may automatically be added by GitHub Actions CI.
| Label | When to Use |
| --- | --- | | Label | When to Use |
| `pr/no-changelog` | This PR does not have an intended changelog entry | |----------------------| --- |
| `pr/no-changelog` | This PR does not have an intended changelog entry |
| `pr/no-backport` | This PR does not have an intended backport target |
| `pr/no-metrics-test` | This PR does not require any testing for metrics | | `pr/no-metrics-test` | This PR does not require any testing for metrics |
| `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page to view active releases. Website documentation merged to the latest release branch is deployed immediately | | `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page and [`versions.hcl`](/.release/versions.hcl) to view active releases. Website documentation merged to the latest release branch is deployed immediately. See [backport policy](#backport-policy) for more information. |
Other labels may automatically be added by the Github Action CI. | `backport/all` | If contributing a bug fix or other change applicable to all branches, use `backport/all` to target all active branches automatically. See [backport policy](#backport-policy) for more information. |
7. After you submit, the Consul maintainers team needs time to carefully review your 7. After you submit, the Consul maintainers team needs time to carefully review your
contribution and ensure it is production-ready, considering factors such as: security, contribution and ensure it is production-ready, considering factors such as: security,
backwards-compatibility, potential regressions, etc. backwards-compatibility, potential regressions, etc.
@ -174,6 +177,10 @@ When you're ready to submit a pull request:
Assuming the tests pass, the PR will be merged automatically. Assuming the tests pass, the PR will be merged automatically.
If the tests fail, it is you responsibility to resolve the issues with backports and request another reviewer. If the tests fail, it is you responsibility to resolve the issues with backports and request another reviewer.
### Backport Policy
Consul is maintained as a Community Edition (CE) and an Enterprise product. Bug fixes and patches may be backported to the current major release in CE. In Enterprise, bug fixes and patches may be backported to all maintained releases: the N-2 releases and the 2 latest Long-Term Support (LTS) releases. For more information, refer to Consul’s [LTS documentation](https://developer.hashicorp.com/consul/docs/enterprise/long-term-support).
#### Checklists #### Checklists
Some common changes that many PRs require are documented through checklists as Some common changes that many PRs require are documented through checklists as

1
contributing/INTERNALS.md
View File

@ -1 +0,0 @@
Moved to [docs/README.md](../docs/README.md).

1
contributing/README.md
View File

@ -1 +0,0 @@
Moved to [docs](../docs/README.md).