0308cbad9b50962f40af8b1af1805dd6c3eb6933
internal/RegistryReviewGuidelines.md
| ... | ... | @@ -86,6 +86,27 @@ If you get stuck or are unsure, ask for a secondary review. In exceptional circu |
| 86 | 86 | |
| 87 | 87 | Mistakes happen, every single other reviewer has broken something at some point. |
| 88 | 88 | |
| 89 | +## Checklists |
|
| 90 | + |
|
| 91 | +The checklist feature in gitea allows reviewers to embed interactive, trackable to-do lists by including markdown check boxes in the pull request body. |
|
| 92 | + |
|
| 93 | +Checklists are integrated in to the pipeline automation: |
|
| 94 | + - Pipeline will automatically add some standard tasks for new mntners |
|
| 95 | + - Pipeline will fail if there are outstanding checklist items |
|
| 96 | + |
|
| 97 | +Reviewers may add their own tasks that will be monitored by pipeline by including HTML comment markers: |
|
| 98 | + |
|
| 99 | +```text |
|
| 100 | +<!-- pipeline-tasklist-start --> |
|
| 101 | +--- |
|
| 102 | +Please complete the following tasks: |
|
| 103 | + |
|
| 104 | +- [ ] I have read the allocation policies: https://dn42.dev/Policies |
|
| 105 | +<!-- pipeline-tasklist-end --> |
|
| 106 | +``` |
|
| 107 | + |
|
| 108 | +Tasks can be added without the markers, but pipeline won't see them and won't complain if they aren't completed. |
|
| 109 | + |
|
| 89 | 110 | ## Deletions |
| 90 | 111 | |
| 91 | 112 | When reviewing deletions, give the submitter more leeway. If someone is leaving they may not be interested in strictly adhering to the review policies but we still do want to clear out dead allocations. Submitters may not feel that they can edit objects that are not owned by them (e.g. references from other user's AS-SETs) |