Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Alexandrammr - Adding steps in instructions for #2150 #6667

Merged
merged 13 commits into from
May 27, 2021
Merged

Alexandrammr - Adding steps in instructions for #2150 #6667

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5424d6d
Create choose_pull_request.md
AlexandraMMR May 22, 2021
02a0d31
Create merge_pull_request.md
AlexandraMMR May 22, 2021
84c1db2
Create write_commit_message_pull_request.md
AlexandraMMR May 22, 2021
e8326e9
Create confirm_merge.md
AlexandraMMR May 22, 2021
f588855
Create delete_branch.md
AlexandraMMR May 22, 2021
a641adf
Update adding-content-to-your-github-pages-site-using-jekyll.md
AlexandraMMR May 22, 2021
b14b508
Update choose_pull_request.md
AlexandraMMR May 26, 2021
9878347
Update data/reusables/files/delete_branch.md
AlexandraMMR May 26, 2021
d99c14e
Update data/reusables/files/merge_pull_request.md
AlexandraMMR May 26, 2021
c3a92f5
Update delete_branch.md
AlexandraMMR May 26, 2021
bc79447
Update merge_pull_request.md
AlexandraMMR May 26, 2021
d7aecd6
Update choose_pull_request.md
AlexandraMMR May 26, 2021
e4e0a57
Merge branch 'main' into AlexandraMMR-patch-2
ethanpalm May 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions ...pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ Your theme includes default layouts, includes, and stylesheets that will automat
{% data reusables.files.choose-commit-email %}
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_file_change %}
{% data reusables.files.choose_pull_request %}
{% data reusables.files.merge_pull_request %}
{% data reusables.files.write_commit_message_pull_request %}
{% data reusables.files.confirm_merge %}
{% data reusables.files.delete_branch %}

### Adding a new post to your site

Expand All @@ -64,6 +69,11 @@ Your theme includes default layouts, includes, and stylesheets that will automat
{% data reusables.files.choose-commit-email %}
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_file_change %}
{% data reusables.files.choose_pull_request %}
{% data reusables.files.merge_pull_request %}
{% data reusables.files.write_commit_message_pull_request %}
{% data reusables.files.confirm_merge %}
{% data reusables.files.delete_branch %}

Your post should now be up on your site! If the base URL of your site is `https://octocat.github.io`, then your new post will be located at `https://octocat.github.io/YYYY/MM/DD/TITLE.html`.

Expand Down
1 change: 1 addition & 0 deletions data/reusables/files/choose_pull_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. Once you create the Pull Request with your changes, in the "Pull Requests" list, click the pull request you'd like to merge.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Once you create the Pull Request with your changes, in the "Pull Requests" list, click the pull request you'd like to merge.
1. Create a pull request for your proposed changes.

Since the next action we want people to take is to create a pull request, I think we should be clear that they need to do that. So we can start this step by saying "create a pull request" and then the next step will be to merge the PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ethanpalm Thank you so much for all the suggestions, I've applied them. I did add a second step after the Create a PR, to say they need to navigate to the PR list to merge as it wasn't obvious to the users in the intial thread this issue resulted from. Let me know what you think, if you think it's not needed we can remove it 😁

1 change: 1 addition & 0 deletions data/reusables/files/confirm_merge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. Click **Confirm merge**.
1 change: 1 addition & 0 deletions data/reusables/files/delete_branch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. Optionally, [delete the branch](/articles/deleting-unused-branches). This keeps the list of branches in your repository tidy.
AlexandraMMR marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions data/reusables/files/merge_pull_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1. Merge all of the commits into the base branch by clicking **Merge pull request**. For more information, see "[Merging a Pull Request](/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)".
AlexandraMMR marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions data/reusables/files/write_commit_message_pull_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
1. If prompted, type a commit message, or accept the default message.
![Commit message field](/assets/images/help/pull_requests/merge_box/pullrequest-commitmessage.png)