Working with Pull Requests
Pull requests are essential features in Git workflows, used to merge features or bug fixes between branches while enforcing review processes. They represent the cornerstone of collaboration in Git-based development. APIGit provides a GitHub-like experience for managing pull requests.
Accessing Pull Requests
Global Pull Request View
Review all pull requests you’re involved with from the global view. This includes pull requests you’ve created, those assigned to you, or any you’ve collaborated on.
Repository-Specific Pull Requests
When working within a specific API repository, navigate to the repository’s Pull Requests tab to see pull requests specific to that repository.
To create a new pull request, click the Create Pull Request button in the upper right corner of the repository pull request list.
Collaborating on Pull Requests
When you click on a pull request, you’ll enter its detail page where you can:
- Discuss through the “Conversation” tab
- Assign owners and reviewers
- Add tags and categorize the request
- Review commits included in the pull request
- Examine file changes through diffs
- Approve, reject, or merge the pull request
Discussion and Assignment
Under the “Conversation” tab, you can discuss any aspect of the pull request with your team.
On the right side of the conversation panel, you can assign the pull request to team members or colleagues as reviewers or owners.
Commit Review
Under the “Commits” tab, you can see all commits included in this pull request.
Governance Rules Check (Enterprise Plan Only)
Under the “Governance” tab, you can review any API governance violations for the changed files.
File Diff Review
Under the “File Diff” tab, you can review all file changes included in the pull request. This view provides the basis for approving or rejecting changes.
Advanced Configuration: Pull Request Settings
If you need to customize pull request behavior for different branches or set up branch protection rules, you can do so in the repository’s settings.
Navigate to the repository’s settings page to create branch protection policies, where you can configure:
- Number of required approvers for pull requests
- Merge methods and restrictions
- Branch protection rules
- Other pull request-related settings
These settings allow you to enforce your team’s development and review standards throughout the pull request process.