Skip to content

Commit

Permalink
refactor project management and review guideline documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ll7 committed Oct 24, 2024
1 parent 6e9cfc1 commit ec2b85e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/development/project_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Merge the pull request after:
3. All required checks have passed
4. The branch is up-to-date with the main branch

After merging, remember to delete the source branch to keep the repository clean.
After merging, remember to delete the source branch to keep the repository clean.

>[!INFO] For more information about the review process, see [Review process](./review_guideline.md).
19 changes: 10 additions & 9 deletions doc/development/review_guideline.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,28 +102,29 @@ If a new commit took place it is encouraged to comment the commit SHA to have a
### 5.1. Pre-merge Checklist

Before merging, ensure:

- [ ] All conversations are resolved
- [ ] Required CI/CD checks are passing
- [ ] No pending change requests
- [ ] Code has been reviewed thoroughly
- [ ] Documentation is up-to-date

The reviewer should always be the person to merge the PR after an approved review.
The reviewer should always be the person to merge the PR after an approved review.

If the reviewer has anything he/she would like to have changed or clarified, the review should be marked as `Request Changes`.
If there are no uncertainties the reviewer merges the PR. After a revision of the requested changes the reviewer conducts a second review, if he/she is satisfied with the changes, the PR will be merged by him/her.
If the reviewer has anything he/she would like to have changed or clarified, the review should be marked as `Request Changes`.
If there are no uncertainties the reviewer merges the PR. After a revision of the requested changes the reviewer conducts a second review, if he/she is satisfied with the changes, the PR will be merged by him/her.

Long story short, the reviewer who approves the PR should merge. Only approve if there is nothing to change.
Long story short, the reviewer who approves the PR should merge. Only approve if there is nothing to change.

### 5.2. Required Checks
### 5.2. Required Checks

Before merging a pull request, the request checks by the CI/CD pipeline should be successful. If the checks fail, the pull request should not be merged.
Before merging a pull request, the request checks by the CI/CD pipeline should be successful. If the checks fail, the pull request should not be merged.

> [!INFO] An exception can be made for a PR that only addresses the documentation and the `driving` check is not yet completed.
> [!INFO] An exception can be made for a PR that only addresses the documentation and the `driving` check is not yet completed.
### 5.3. Deleting the branch
### 5.3. Deleting the branch

After the PR is merged, the branch should be deleted. This should be done by the person who merged the PR.
After the PR is merged, the branch should be deleted. This should be done by the person who merged the PR.

## 6. Deadlines for pull requests and reviews

Expand Down

0 comments on commit ec2b85e

Please sign in to comment.