-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Project Management and PR (#351)
* Update project management and review guideline documentation Fixes Update Project Management and PR #350 * Update project management and review guideline documentation * refactor project management and review guideline documentation
- Loading branch information
Showing
2 changed files
with
85 additions
and
96 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,85 +1,31 @@ | ||
# Project management | ||
|
||
(Kept from previous group [paf22]) | ||
**Summary:** We use [issues](https://github.com/una-auxme/paf/issues) and [milestones](https://github.com/una-auxme/paf/milestones) to manage the project. This document explains how to create issues and pull requests. | ||
|
||
**Summary:** We use a [Github Project](https://github.com/users/ll7/projects/2) for project management. | ||
Any bugs or features requests are managed in Github. | ||
- [1. Create bug or feature requests](#1-create-bug-or-feature-requests) | ||
- [2. Create a Pull Request](#2-create-a-pull-request) | ||
|
||
- [Project management](#project-management) | ||
- [Create bug or feature requests](#create-bug-or-feature-requests) | ||
- [🐞 Bug](#-bug) | ||
- [Example for "Bug"](#example-for-bug) | ||
- [💡 Feature](#-feature) | ||
- [Example for "Feature"](#example-for-feature) | ||
- [🚗 Bug in CARLA Simulator](#-bug-in-carla-simulator) | ||
- [Example for "Bug in CARLA Simulator"](#example-for-bug-in-carla-simulator) | ||
- [Create a Pull Request](#create-a-pull-request) | ||
- [Merging a Pull Request](#merging-a-pull-request) | ||
- [Deadlines for pull requests and reviews](#deadlines-for-pull-requests-and-reviews) | ||
## 1. Create bug or feature requests | ||
|
||
## Create bug or feature requests | ||
|
||
Bugs or features can be added [here](https://github.com/ll7/paf22/issues/new/choose) or via the [issue overview](https://github.com/ll7/paf22/issues). | ||
Issues can be added via the [issues overview](https://github.com/una-auxme/paf/issues). | ||
|
||
![create issue](../assets/create_issue.png) | ||
|
||
By clicking "New issue" in the overview or using the direct link above a wizard guides you to the creation of an issue: | ||
|
||
![issue wizard](../assets/issue_wizard.png) | ||
|
||
The possibilities are described in the following sections. | ||
|
||
### 🐞 Bug | ||
|
||
Use this issue type if you encounter a problem which should already work. | ||
If something is not expected to work, but you want to have it, please refer to the Feature section. | ||
|
||
#### Example for "Bug" | ||
|
||
The documentation says that the vehicle should detect about 90% of the traffic lights. | ||
However, for you it ignores almost all traffic lights. | ||
|
||
![bug template](../assets/bug_template.png) | ||
|
||
### 💡 Feature | ||
|
||
Use this template if you want a new Feature which is not implemented yet. | ||
|
||
#### Example for "Feature" | ||
By clicking "New issue" in the overview you have different templates to create the issue. | ||
|
||
Currently, the vehicle can't make u-turns. | ||
Implementing the ability to perform u-turns would be a new feature. | ||
## 2. Create a Pull Request | ||
|
||
![feature template](../assets/feature_template.png) | ||
|
||
### 🚗 Bug in CARLA Simulator | ||
|
||
This is a shortcut to directly report an issue in CARLA Simulator which is not an error in this project. | ||
|
||
#### Example for "Bug in CARLA Simulator" | ||
|
||
CARLA simulator crashes on startup on your machine. | ||
|
||
## Create a Pull Request | ||
|
||
To create a pull request, go to the [branches overview](https://github.com/ll7/paf22/branches) and select ``New Pull Request`` for the branch you want to create a PR for. | ||
To create a pull request, go to the [branches overview](https://github.com/una-auxme/paf/branches) and select ``New Pull Request`` for the branch you want to create a PR for. | ||
![img.png](../assets/branch_overview.png) | ||
<!-- TODO image is outdated --> | ||
|
||
Merge the pull request after the review process is complete and all the feedback from the reviewer has been worked in. | ||
|
||
For more information about the review process, see [Review process](./review_guideline.md). | ||
|
||
## Merging a Pull Request | ||
|
||
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. | ||
|
||
Long story short, the reviewer who approves the PR should merge. Only approve if there is nothing to change. | ||
Merge the pull request after: | ||
|
||
## Deadlines for pull requests and reviews | ||
1. The review process is complete | ||
2. All reviewer feedback has been addressed | ||
3. All required checks have passed | ||
4. The branch is up-to-date with the main branch | ||
|
||
The deadline for submitting a pull request is **Tuesday** before the end of the sprint at **12:15**. | ||
After merging, remember to delete the source branch to keep the repository clean. | ||
|
||
The deadline for submitting a review for a pull request is **Wednesday** before the end of the sprint at **12:15**. | ||
>[!INFO] For more information about the review process, see [Review process](./review_guideline.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters