Skip to content

Commit faa9de3

Browse files
committed
Add further pages and link to guide from README.md
1 parent b9124ad commit faa9de3

File tree

6 files changed

+17
-5
lines changed

6 files changed

+17
-5
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Update potentially outdated instructions, commands, or version numbers. These ta
9999

100100
## Further resources
101101

102+
If you're new to GitHub and working on the command line, you may want to start off with our [getting started guide](getting-started/get_started.md). Even if you are running a Windows machine, you can start contributing using this guide.
103+
102104
### Community forum
103105

104106
Our community forum is the hub for all things Open Documentation Academy. It includes our _Getting started_ guide and links to our weekly _Documentation office hours_, alongside meeting notes, updates, external links and discussions.

getting-started/CLI_basics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Working on the command line takes a little getting used to, but doesn't need too
44

55
|||
66
| -- | -- |
7-
| `cd <folder>` | Change directory to `<folder>` |
7+
| `cd <folder>` | Change directory down to `<folder>` |
8+
| `cd ..` | Go back up one directory level |
89
| `ls` (or `ls -all`) | Lists all files (including hidden files) |
910
| `touch <file name>` | Create an empty file called `<file name>` |
1011
| `rm <file name>` | Remove the file called `<file name>` |
72.9 KB
Loading
32.1 KB
Loading

getting-started/install_git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ https://github.com/canonical/open-documentation-academy
108108

109109
This will download everything into a new folder *inside your `src` folder*, called "open-documentation-academy". This will be important later!
110110

111-
111+
Next, let's start using git to learn how it works! [Working with git on the command line](using_git.md)
112112

113113

114114

getting-started/using_git.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,19 @@ The next time I go to the main repository on the website, I should have a yellow
158158

159159
## Create a pull request
160160

161+
Now you have pushed your changes to your remote fork, you can go back to the GitHub website. Navigate to the Open Documentation Academy repository page, and you should see a banner like this:
161162

163+
!["New pull request" banner](images/new_pull_request.png)
164+
165+
You can click on the "Compare and pull request" button to review what you've submitted, and to create a pull request. The pull request is used to **pull** the changes from your remote fork into the original repository.
166+
167+
![](images/create_pull_request.png)
168+
169+
In the line at the top, we can see that we are proposing to bring changes from my test branch, on my fork into the origin repository's main branch.
170+
171+
When we open a pull request, we usually include a description as well, to say what changes we've made (and why), and sometimes a repository will have other information they want you to include with your pull request. In those cases, they might have a template that you should fill out. Not following the template (if one is provided) can slow down the process of getting your PR approved and merged.
172+
173+
When you're happy with your message, click the "Create pull request" button. At this point, the maintainers of the repository will be notified of your new pull request, and it will undergo a review process. As part of that process you might be asked to...
162174

163175
## Edit a pull request
164176

@@ -179,9 +191,6 @@ git push <your-remote-name> <your-branch>
179191
This will take the changes you have made, and update your pull request automatically!
180192

181193
You can make as many changes as you like using this method, until the pull request is ready to be accepted and merged.
182-
183-
### If you have un-stashed changes…
184-
185194

186195
## Updating, rebasing and merge conflicts
187196

0 commit comments

Comments
 (0)