-
Notifications
You must be signed in to change notification settings - Fork 0
08. Pull Request Process
This section describes how pull requests are used to integrate completed work into the main code base in a controlled and reviewable way.
After implementation on a feature or chore branch is completed, a pull request (PR) is created on GitHub.
The pull request:
- targets the
developbranch - is created from the corresponding feature or chore branch
- represents the completion of a specific user story or task
Creating a pull request marks the transition from implementation to review.
Each pull request contains the following information:
- A clear description of the implemented changes
- A summary of what was added, changed, or tested
- A link to the related GitHub Issue (user story)
- Information about test coverage and results, if applicable
This ensures that reviewers can understand the purpose and scope of the changes without inspecting every code change in detail.
The project uses a mandatory review process.
- At least one second person must review the pull request
- Reviews are enforced via GitHub repository settings
- The reviewer can:
- approve the pull request
- request changes
If changes are requested:
- the developer updates the branch
- CI/CD pipelines run again automatically
- the pull request is reviewed again
A pull request cannot be merged without an approved review.
CI/CD pipelines are automatically triggered when a pull request is created or updated.
- Pipelines run build and verification steps
- If the pipeline fails, merging is blocked
- Only pull requests with successful checks can be merged
This ensures code quality and stability.
The project uses Merge Commit as the merge strategy.
- All commits from the branch are preserved
- The merge commit documents when and why changes were integrated
- This supports traceability and auditing of changes
After merging:
- the linked GitHub Issue is automatically updated
- the user story is moved to Done in the Kanban board
The following screenshot shows a real pull request from the SheCounts project.
It demonstrates:
- a descriptive pull request description
- linked GitHub Issue
- requested reviewers
- CI/CD status
- merge readiness
