Administrator/Xen-Orchestra-xen-orchestra-MIRROR
1
0
Fork 1
mirror of https://github.com/vatesfr/xen-orchestra.git synced 2026-11-09 17:06:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(PULL_REQUEST_TEMPLATE): point to internal review process instead of duplicating it (#10517)

Browse Source 
The review process was documented both here and in the internal PR process
doc, and the two had drifted apart. Keep the internal doc as the single
source of truth and only give external contributors what they need.
This commit is contained in:
Pierre Donias
2026-10-05 09:59:05 +02:00
committed by GitHub
parent 440624a09c
commit 5de02b6c19
1 changed files with 7 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
PULL_REQUEST_TEMPLATE.md
View File

@@ -6,42 +6,17 @@ _Short explanation of this PR (feel free to re-use commit message)_
- Commit - Commit
- Title follows [commit conventions](https://bit.ly/commit-conventions) - Title follows [commit conventions](https://bit.ly/commit-conventions)
- Reference the relevant issue (`Fixes #007`, `See xoa-support#42`, `See https://...`) - Reference the relevant issue, forum thread, discussion, ... (`Fixes #007`, `See xoa-support#42`, `See https://...`)
- If bug fix, add `Introduced by` - If bug fix, add `Introduced by <commit|PR>`
- Changelog - Changelog
- If visible by XOA users, add changelog entry - If visible by XOA users, add changelog entry to `CHANGELOG.unreleased.md`
- If visible by XO Lite users, add changelog entry to `@xen-orchestra/lite/CHANGELOG.md`
- Update "Packages to release" in `CHANGELOG.unreleased.md` - Update "Packages to release" in `CHANGELOG.unreleased.md`
- PR - PR
- If UI changes, add screenshots - If UI changes, add a `### Screenshots` section above this checklist
- If not finished or not tested, open as _Draft_ - If not finished or not tested, open as _Draft_
### Review process ### Review process
If you are an external contributor, you can skip this part. Simply create the pull request, and we'll get back to you as soon as possible. - External contributors: simply open the pull request, we'll get back to you as soon as possible.
- Vates developers: follow the internal pull request process.
> This 2-passes review process aims to:
>
> - develop skills of junior reviewers
> - limit the workload for senior reviewers
> - limit the number of unnecessary changes by the _author_
1. The _author_ creates a PR.
2. Review process:
1. The _author_ assigns the _junior reviewer_.
2. The _junior reviewer_ conducts their review:
- Resolves their comments if they are addressed.
- Adds comments if necessary or approves the PR.
3. The _junior reviewer_ assigns the _senior reviewer_.
4. The _senior reviewer_ conducts their review:
- If there are no unresolved comments on the PR → merge.
- Otherwise, we continue with **3.**
3. The _author_ responds to comments and/or makes corrections, and we go back to **2.**
Notes:
1. The _author_ can request a review at any time, even if the PR is still a _Draft_.
2. In theory, there should not be more than one reviewer at a time.
3. The _author_ should not make any changes:
- When a reviewer is assigned.
- Between the _junior_ and _senior_ reviews.
4. If the PR relates to a change in the openAPI specification, a member of the DevOps team must also participate in the review.