Skip to content

Commit c53b458

Browse files
authored
review: review of edit/comit/pr content
2 parents f8140b9 + 5b62fc3 commit c53b458

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

contribute-open-source/fork-repo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ myst_html_meta:
3232
>
3333
> Forking lets you work on a project independently before suggesting changes.
3434
35-
## What is forking, and why use it?
35+
## What is forking and why use it?
3636

3737
Forking a repository **creates a copy** in your GitHub account while keeping a link to the original.
3838

contribute-open-source/github-codespaces.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ However, in some cases, developers have set up a codespace for you to use on Git
2020
Codespaces are a feature that is specific to GitHub and are free for up to 60 hours a month. After that 60 hours, you need to pay for the service.
2121

2222
(about-codespace)=
23+
2324
## What is a codespace
2425

2526
GitHub Codespaces is a cloud-based development environment integrated into GitHub. It provides fully configured, container-based environments that you can use to modify files in a GitHub repository.

contribute-open-source/pull-request.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,10 @@ Animated gif showing that GitHub will prompt you to make a new pul request when
6262
### Step 2: Setup your pull request targets (head and base)
6363

6464
:::{figure} /images/github/github-pr-targets-head-base.png
65-
When you setup your pull request, you will need to specify the head and the base. The head refers to the branch that is a-HEAD of the parent repository--ie a branch on your fork! The base is the parent repository that you wish to submit changes to.
65+
When you setup your pull request, you need to specify the head and the base. The head refers to the branch and associated repository that is **a-HEAD** of the parent repository--for example, a branch on your fork! The base is the parent repository that you wish to submit changes to.
6666
:::
6767

68+
6869
When creating a **pull request (PR)**, you need to define where your changes should be added and where they come from.
6970

7071
- **<i class="fa-solid fa-database" style="color: #81c0aa;"></i> Base:** The repository where you want your changes to be merged. *(This is usually the original repo you forked.)*
@@ -82,6 +83,12 @@ In this example, you want to update:
8283
> go to the right place. If you accidentally select the wrong base, your PR might not
8384
> reach the maintainers you intended. Double-check this before submitting!
8485
86+
:::{admonition} What is a branch
87+
88+
A branch is a working version of a git repository that you can use to work on features, bugs, and more. Branches allow you to work on files in isolation, rather than working on the main version of the repository.
89+
[Learn more about GitHub branches here.](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)
90+
:::
91+
8592
:::{todo}
8693

8794
/images/github/base-vs-head.png
@@ -92,7 +99,7 @@ Create Graphic: Simple diagram with arrows from "Your Fork (Head)" → "Original
9299

93100
### Step 3: Review your own pull request first
94101

95-
When comparing repositories in a **pull request (PR)**, GitHub provides a **diff view** of changes between files (diff as in difference). Before submitting the pr, carefully review these changes to ensure that what you intended to submit is in the PR (and nothing else).
102+
When comparing repositories in a **pull request (PR)**, GitHub provides a **diff view** of changes between files (diff as in difference). Before submitting the PR, carefully review these changes to ensure that what you intended to submit is in the PR (and nothing else).
96103

97104
Since others will review your PR, take time to **clean up unnecessary changes** before submitting. Your time upfront will lead to the PR being merged sooner and will make it easier for others to review.
98105

@@ -105,6 +112,7 @@ Before you submit your PR, check:
105112

106113
1. **The number of files:** Do they match what you intended to modify?
107114
2. **Review changes in each file:** Are all modifications correct and expected?
115+
3. **Make sure there aren't merge conflicts:** A merge conflict occurs when two or more people edit the same lines of a file, and Git doesn’t know which changes to accept. This most commonly happens when you modify a file on a branch, but someone else also updates those same lines in the parent repository before your changes are merged. You can check if your PR has merge conflicts by looking at the bottom of the PR page.
108116

109117
:::{figure} /images/github/pr-check-files.gif
110118

0 commit comments

Comments
 (0)