You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contribute-open-source/github-codespaces.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,7 @@ However, in some cases, developers have set up a codespace for you to use on Git
20
20
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.
21
21
22
22
(about-codespace)=
23
+
23
24
## What is a codespace
24
25
25
26
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.
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.
66
66
:::
67
67
68
+
68
69
When creating a **pull request (PR)**, you need to define where your changes should be added and where they come from.
69
70
70
71
-**<iclass="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:
82
83
> go to the right place. If you accidentally select the wrong base, your PR might not
83
84
> reach the maintainers you intended. Double-check this before submitting!
84
85
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
+
85
92
:::{todo}
86
93
87
94
/images/github/base-vs-head.png
@@ -92,7 +99,7 @@ Create Graphic: Simple diagram with arrows from "Your Fork (Head)" → "Original
92
99
93
100
### Step 3: Review your own pull request first
94
101
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).
96
103
97
104
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.
98
105
@@ -105,6 +112,7 @@ Before you submit your PR, check:
105
112
106
113
1.**The number of files:** Do they match what you intended to modify?
107
114
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.
0 commit comments