This repository has been archived by the owner on Jun 9, 2023. It is now read-only.
Pr tutorial #4
Merged
Pr tutorial #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
namurphy
approved these changes
Oct 26, 2017
| # Creating a Pull Request | ||
| This tutorial will walk you through how to request that someone else pulls your changes to their code into their project. | ||
| This is called a **pull request**, usually abbreviated to PR. | ||
| It is assumed that you are comfortable with using the fundamental git commands (`git add`, `git commit`, etc.) at a command prompt, and that you are familiar with pushing and pulling repositories to and from GitHub. |
There was a problem hiding this comment.
Around here, perhaps it would be worthwhile to link to a resource that describes how to use the basics of git that would be appropriate for someone completely new to it. We could also support people in real time through Matrix or wherever who are new to it also.
| This will make a copy of that repo, and that copy belongs to you. | ||
|
|
||
| ## Clone your fork of the repo | ||
| On your fork of the repo (<_your-github-username_>/PlasmaPy-Tutorials), use the '**Clone or Download**' button to download the repo. |
There was a problem hiding this comment.
It may be helpful to add an example command for git clone here also.
pull-request/README.md
Outdated
|
|
||
| ## Create a new branch in your local repo | ||
| This step is not strictly necessary to make a PR, but is highly recommended as part of the git workflow in general, so we shall take the time to go through it here. | ||
|
|
There was a problem hiding this comment.
The explicit command for creating a branch would likely be helpful here also.
|
Thanks for your comments @namurphy. I've made those changes, so this is ready to merge ahead of tomorrow's tutorial, pending final approval. |
|
Thanks! I think it is ready to be merged. |
|
Huzzah! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document walking through how to create a PR, assuming you already know a little git.