Skip to content

Commit

Permalink
Add exercise to send yourself a PR
Browse files Browse the repository at this point in the history
Fix #102
Fix #103
  • Loading branch information
gcapes committed May 2, 2023
1 parent be5008f commit b76e9fe
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion _episodes/13-pull-requests.md
Expand Up @@ -68,7 +68,7 @@ or you could consider rewriting your history neatly using an interactive rebase
an earlier commit.
In either case, your PR will update automatically once you have pushed your commits.

> ## Send me a pull request!
> ## Send me a Pull Request!
> Let's look at the workflow and try to repeat it:
>
> 1. **Fork** [this
Expand Down Expand Up @@ -96,4 +96,30 @@ In either case, your PR will update automatically once you have pushed your comm
> (or not) via GitHub.
{: .challenge}

## Using issues for planning and discussion
Issues are a great way to plan/project manage your own work.
You can think of them like a to-do list, where you create a new branch for each issue,
to be merged into `master` when completed.
They are also a good place for discussion ahead of creating a pull request.

A nice GitHub integration is that you can close an issue via a commit message
e.g. if you include `Fix #2` in your commit message, it will close issue 2
when merged into master.

> ## Send yourself a Pull Request!
> Pull requests aren't just for repos where you don't have write access.
> You can also create a pull request from a feature branch within your own repo.
> This is a useful workflow if you would like some input from colleagues -
> you can request a review and have discussions on the pull request.
>
> 1. Create a new issue for your repository (e.g. acknowledge funding source)
> 2. Create a new feature branch and switch to it ahead of fixing the issue
> 3. Edit your paper to resolve the issue, and include `Fix #1` in your commit
> message (assuming you're fixing issue #1).
> 4. Push your new feature branch to `origin`
> 5. Create a new pull request from your feature branch to `master`
> (Look for a green button at the top of the `code` tab after pushing)
> 6. Merge your pull request on GitHub, under the "Pull requests" tab
{: .challenge}

{% include links.md %}

0 comments on commit b76e9fe

Please sign in to comment.