Skip to content

Commit 4f03293

Browse files
committed
Add github templates and new page and a contributing markdown file.
1 parent 7c07a10 commit 4f03293

8 files changed

+61
-1
lines changed

CONTRIBUTING.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,4 +225,64 @@ Contributors guide: https://github.com/jbelmont/blob/master/CONTRIBUTING.md
225225
Please try to do your best at filling out the details, but feel free to skip
226226
parts if you're not sure what to put.
227227

228-
Once opened, Pull Requests are usually reviewed within a few days.
228+
Once opened, Pull Requests are usually reviewed within a few days.
229+
230+
#### Sample Pull Request
231+
232+
Steps I took for the Pull Request
233+
234+
I forked the [Unix and Regular Expressions Workshop](https://github.com/jbelmont/unix-programming-and-regular-expressions-workshop)
235+
236+
![Fork Unix Workshop](images.fork.png)
237+
238+
I then clicked the Clone or Download Button
239+
240+
![Clone Button](images/clone.png)
241+
242+
I ran the following terminal commands:
243+
244+
* `git clone https://github.com/thejohnrambo/unix-programming-and-regular-expressions-workshop.git a-test-fork-repo`
245+
* This makes a local cloned copy of the repo
246+
* `git remote add upstream https://github.com/jbelmont/unix-programming-and-regular-expressions-workshop.git`
247+
* This helps add and setup upstream changes for the fork
248+
* `git fetch upstream`
249+
* This command will fetch all the branches for the upstream repository
250+
* In my case master and gh-pages branches
251+
* `git checkout -b file-sharing-edit -t upstream/master`
252+
* This creates a new branch called *file-sharing-edit* with a target set to upstream master branch
253+
* I then made my changes into fork via the *docs/remote-file-sharing-and-file-access.md* file
254+
* Once done I committed my changes
255+
* `git add .`
256+
* `git commit -m 'Added a section to remote file sharing section for using ssh.'`
257+
* These commands add changes to be staged and then commit those changes
258+
* `git push origin file-sharing-edit`
259+
* This pushes up the *file-sharing-edit* branch to github to the forked repository
260+
* If you have another github username you have to do the following:
261+
* `git config credential.helper ""` this will reset credentials stored locally
262+
* If you go back to the root repository which is sitting at the top of the fork
263+
264+
![Fork Link](images/fork-link.png)
265+
266+
Once you go back to the root you can do the Pull Request via 2 ways in Github UI:
267+
268+
1. Click the new link that shows up in the original repository
269+
1. ![Compare & Pull Request](images/compare-and-pr.png)
270+
2. Click *Create Pull Request* Button
271+
2. Click the Pull Request Link
272+
1. Click the *New Pull Request* Button
273+
2. ![Compare Across Forks](images/compare-forks.png)
274+
3. Click compare across forks
275+
4. ![Compare Create Click](images/create-compare-across-forks.png)
276+
1. Notice here that there is a base fork which is *jbelmont/unix-programming-and-regular-expressions-workshop*
277+
2. And there is a head fork which is *thejohnrambo/unix-programming-and-regular-expressions-workshop*
278+
5. Click *Create pull request*
279+
280+
Once the changes are reviewed and merged then I will run `npm run docs:publish` so that they get published to gitbook.
281+
282+
When I login I will be able to merge and assign Pull Request to others
283+
284+
![My View](images/admin-pr-view.png)
285+
286+
The second to last step is to merge the changes with *Merge pull request* button
287+
288+
![Last Merge](images/merge-pr.png)

images/admin-pr-view.png

359 KB
Loading

images/clone.png

48.3 KB
Loading

images/compare-and-pr.png

185 KB
Loading

images/compare-forks.png

134 KB
Loading
214 KB
Loading

images/fork-link.png

66.4 KB
Loading

images/merge-pr.png

128 KB
Loading

0 commit comments

Comments
 (0)