|
2 | 2 |
|
3 | 3 | To maintain a consistent and efficient development workflow, we have set specific label guidelines for all pull requests (PRs). Please ensure you adhere to the following instructions: |
4 | 4 |
|
5 | | -### Mandatory team labels: |
| 5 | +## Mandatory team label (automated) |
6 | 6 |
|
7 | 7 | - **Internal Developers**: Every PR raised by an internal developer must include a label prefixed with `team-` (e.g., `team-extension-ux`, `team-extension-platform`, etc.). This indicates the respective internal team responsible for the PR. |
8 | 8 |
|
9 | 9 | - **External Contributors**: PRs submitted by contributors who are not part of the organization will be automatically labeled with `external-contributor`. |
10 | 10 |
|
11 | | -It's essential to ensure that PRs have the appropriate labels before they are considered for merging. |
| 11 | +## Mandatory checklog entry or label (manual addition) |
12 | 12 |
|
13 | | -### Mandatory release version labels: |
| 13 | +The releases changelog generation is based on PR's changelog entries. |
| 14 | +The check can be bypassed when necessary, either by setting the changelog entry to "null" or by adding following label: |
14 | 15 |
|
15 | | -- **release-x.y.z**: This label is automatically added to a PR and its linked issues upon the PR's merge. The `x.y.z` in the label represents the version in which the changes from the PR will be included. This label is auto-generated by a [GitHub action](../workflows/add-release-label.yml), which determines the version by incrementing the minor version number from the most recent release. Manual intervention is only required in specific cases. For instance, if a merged PR is cherry-picked into a release branch, typically done to address Release Candidate (RC) bugs, the label would need to be manually updated to reflect the correct version. |
16 | | -- **regression-prod-x.y.z**: This label is automatically added to a bug report issue at the time of its creation. The `x.y.z` in the label represents the version in which the bug first appeared. This label is auto-generated by a [GitHub action](../workflows/check-template-and-add-labels.yml), which determines the `x.y.z` value based on the version information provided in the bug report issue form. Manual intervention is only necessary under certain circumstances. For example, if a user submits a bug report and specifies the version they are currently using, but the bug was actually introduced in a prior version, the label would need to be manually updated to accurately reflect the version where the bug originated. |
17 | | -- **regression-RC-x.y.z**: This label is manually added to a bug report issue by release engineers when a bug is found during release regerssion testing phase. The `x.y.z` in the label represents the release candidate (RC) version in which the bug's been discovered. |
| 16 | +- **no-changelog**: PR's changes do not need to be included in the changelog. |
| 17 | + |
| 18 | +## Optional labels (manual addition) |
| 19 | + |
| 20 | +Any label can be manually added on demand depending on the PR's content. For instance, the label **QA passed** will indicate that a thorough manual testing has been performed and the PR is ready to be merged. In addition, following labels have some specific use cases. |
18 | 21 |
|
19 | | -### Optional labels: |
| 22 | +### Bypass Quality Gates |
20 | 23 |
|
21 | | -- **regression-main**: This label can manually be added to a bug report issue at the time of its creation if the bug is present on the development branch, i.e., `main`, but is not yet released in production. |
22 | | -- **feature-branch-bug**: This label can manually be added to a bug report issue at the time of its creation if the bug is present on a feature branch, i.e., before merging to `main`. |
23 | | -- **needs-qa**: If the PR includes a new features, complex testing steps, or large refactors, this label must be added to indicated PR requires a full manual QA prior being merged and added to a release. |
| 24 | +Using any of these labels should be exceptional in case of CI friction and urgencies. Please use them reasonably and verify new changes and regressions manually. |
24 | 25 |
|
25 | | -### Labels prohibited when PR needs to be merged: |
| 26 | +- **skip-e2e-quality-gate**: This label will disable the default test retries for E2E test files modified in the PR. Useful when making large refactors or when changes don't pose flakiness risk. |
26 | 27 |
|
27 | | -Any PR that includes one of the following labels can not be merged: |
| 28 | +### Block merge if any is present |
28 | 29 |
|
29 | 30 | - **needs-qa**: The PR requires a full manual QA prior to being merged and added to a release. |
30 | | -- **QA'd but questions**: The PR has been checked by QA, but there are pending questions or clarifications needed on minor issues that were found. |
31 | | -- **issues-found**: The PR has been checked by QA or other reviewers, and appeared to include issues that need to be addressed. |
32 | 31 | - **need-ux-ds-review**: The PR requires a review from the User Experience or Design System teams. |
33 | 32 | - **blocked**: There are unresolved dependencies or other issues blocking the progress of this PR. |
34 | 33 | - **stale**: The PR has not had recent activity in the last 90 days. It will be closed in 7 days. |
35 | 34 | - **DO-NOT-MERGE**: The PR should not be merged under any circumstances. |
36 | 35 |
|
| 36 | +## Release version label (automated) |
| 37 | + |
| 38 | +- **release-x.y.z**: This label is automatically added to a PR and its linked issues upon the PR's merge. The `x.y.z` in the label represents the version in which the changes from the PR will be included. This label is auto-generated by a [GitHub action](../workflows/add-release-label.yml), which determines the version by incrementing the minor version number from the most recent release. Manual intervention is only required in specific cases. For instance, if a merged PR is cherry-picked into a release branch, typically done to address Release Candidate (RC) bugs, the label would need to be manually updated to reflect the correct version. |
| 39 | + |
37 | 40 | To maintain code quality and project integrity, it's crucial to respect these label guidelines. Please ensure you review and update labels appropriately throughout the PR lifecycle. |
38 | 41 |
|
39 | 42 | Thank you for your cooperation! |
0 commit comments