Skip to content

Commit

Permalink
Revised text for merge_pull_requests.md
Browse files Browse the repository at this point in the history
Fixed typos and punctuation
  • Loading branch information
e-BaMaMe authored Oct 27, 2024
1 parent 8320a2d commit 1c86f2f
Showing 1 changed file with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
 
```{epigraph}
{% endif %}
Merge Request (<i class="fab fa-gitlab"></i>) or Pull Request (<i class="fab fa-github"></i>) are formal request by a developer to have their code changes merged from one branch into another branch
Merge Request (<i class="fab fa-gitlab"></i>) or Pull Request (<i class="fab fa-github"></i>) are formal request by a developer to have their code changes merged from one branch into another branch.
{% if page %}
```
{% endif %}
Expand Down Expand Up @@ -32,12 +32,12 @@ This can be useful to group related issues and discuss the implementation with o
|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Source Branch** | {% if slide %}{octicon}`git-branch` Branch containing changes{% else %}The branch containing the new changes that will be merged into the target branch (e.g., main or develop).{% endif %} |
| **Target Branch** | {% if slide %}{octicon}`git-branch` Branch into which changes should be introduced{% else %}The branch where the changes are merged into, typically the main or develop branch.{% endif %} |
| **Description** | {% if slide %}**Title** and a short **description** that outlines what is implemented and how.{% else %}Each Merge/Pull Request has a title and a brief description outlining the changes made in the branch. It can also contain specific keywords ([<i class="fab fa-github"></i>](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) or [<i class="fab fa-gitlab"></i>](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)), such as to close a specific issue once the request is accepted.{% endif %} |
| **Assignees** | {% if slide %}A designated **responsible for the implementation** of the changes.{% else %}Merge/Pull Request can be assigned to specific team members to clarify responsibilities and facilitate project management.{% endif %} |
| **Reviewers** | {% if slide %}Person(s) responsible for overseeing the introduction of changes{% else %}One or several members of the repository assigned to review the changes and provide feedback. Typically, a reviewer should be very familiar with the parts of the target branch that are affected by the changes.{% endif %} |
| **Description** | {% if slide %}**Title** and a short **description** that outlines what is implemented and how {% else %}Each Merge/Pull Request has a title and a brief description outlining the changes made in the branch. It can also contain specific keywords ([<i class="fab fa-github"></i>](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) or [<i class="fab fa-gitlab"></i>](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)), such as to close a specific issue once the request is accepted.{% endif %} |
| **Assignee(s)** | {% if slide %}A designated person(s) **responsible for the implementation** of changes {% else %}Merge/Pull Request can be assigned to specific team members to clarify responsibilities and facilitate project management.{% endif %} |
| **Reviewer(s)** | {% if slide %}Person(s) responsible for overseeing the introduction of changes{% else %}One or several members of the repository assigned to review the changes and provide feedback. Typically, a reviewer should be very familiar with the parts of the target branch that are affected by the changes.{% endif %} |
| **State** | {% if slide %}Either {octicon}`git-pull-request` **opened**, {octicon}`git-merge` **merged** or {octicon}`git-pull-request-closed` **closed**{% else %}To track progress on an Merge/Pull Request, generally it can have three states {octicon}`git-pull-request` “open” (still to be merged), {octicon}`git-merge` **merged** (the request has been accepted and the source branch was merged into the target branch) an {octicon}`git-pull-request-closed` “closed” (the request was denied).{% endif %} |
| **Labels** | {% if slide %}A set of arbitrary labels{% else %}Issues can be categorized using labels, e.g., “bug”, “documentation”, etc., to help organize and prioritize work.{% endif %} |
| **News Feed** | {% if slide %}A **chat like activity feed** that allows commenting{% else %}Issues provide an activity or news feed, that displays any related changes and that anyone can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} |
| **News Feed** | {% if slide %}A **chat-like activity feed** to comment on the activities {% else %}Issues provide an activity or news feed, that displays any related changes and that anyone can access and write comments to offer insights, feedback, and exchange ideas on how to resolve an issue.{% endif %} |
| **Milestone** | {% if slide %}Affiliation to a {octicon}`milestone;0.8em` Milestone{% else %}Identical to issues, Merge/Pull Requests can be grouped under milestones and be integrated into an overarching planning, even between repositories for some remote services.{% endif %} |


Expand Down

0 comments on commit 1c86f2f

Please sign in to comment.