Skip to content

Update configuring-commit-squashing-for-pull-requests.md #27909

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.

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

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

jasonfb
Copy link
Contributor

@jasonfb jasonfb commented Aug 31, 2023

clarifies how to find the "Pull requests" section (it's on the General tab but you have to scroll down to see it)

Why:

The existing documentation is confusing

Closes:

none

What's being changed (if available, include any code snippets, screenshots, or gifs):

  • Clarifies that the "Pull requests" section of the repo settings are on the general tab of the repo settings.
  • adds screenshot of the settings

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

clarifies how to find the "Pull requests" section (it's on the General tab but you have to scroll down to see it)
@welcome
Copy link

welcome bot commented Aug 31, 2023

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 31, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 31, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae
fpt
ghec
ghes@ 3.10 3.9 3.8 3.7 3.6
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@jasonfb Thanks for submitting a PR! I'll get it triaged for review. ⚡

However, the screenshot included is not rendering in the staging preview. I'm not sure a screenshot is necessary for this change, though. Perhaps an update to the wording will achieve the goal, but I'll leave that to the reviewer to decide.

For future reference, check out our guide on creating screenshots 👍

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review repositories Content related to repositories and removed triage Do not begin working on this issue until triaged by the team labels Sep 1, 2023
Copy link
Contributor

@am-stead am-stead left a comment

Choose a reason for hiding this comment

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

hi @jasonfb,
Thank you so much for spotting this and for taking the trouble to open a PR for this improvement. I agree, the existing content seems like it could create confusion!
I've proposed some minor edits so that the content aligns more closely with our style guide, if you could take a look and then we'll get it merged! Thanks for this contribution! ✨

@am-stead
Copy link
Contributor

am-stead commented Sep 7, 2023

Hi @jasonfb,
I'm going to go ahead and merge in your changes.
Thanks so much for contributing to our docs! ✨

@am-stead am-stead added this pull request to the merge queue Sep 7, 2023
Merged via the queue into github:main with commit 3744366 Sep 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 7, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants