Skip to content

Re-organize Changing a commit message documentation #158

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

Closed
janiceilene opened this issue Oct 6, 2020 · 5 comments
Closed

Re-organize Changing a commit message documentation #158

janiceilene opened this issue Oct 6, 2020 · 5 comments
Labels
content This issue or pull request belongs to the Docs Content team

Comments

@janiceilene
Copy link
Contributor

janiceilene commented Oct 6, 2020

What feature or product is affected?

Local and remote commits

What is the new or expected behavior?

A user has written in asking if the documentation at

https://help.github.com/en/github/committing-changes-to-your-project/changing-a-commit-message

could be updated to clearly spell out that instructions 1-5 of the section about changing old commits can be used locally, even though the section as a whole is for updating old remote commits.

Content plan

  • We should make the headings H3 so that they show up in the TOC.

  • It's not necessary to split heading by local / remote, as this is GitHub documentation. Instead, we can have the last step be:

    When you're ready to push your changes to GitHub, use the push --force command to force push over the old commit.
    $ git push --force example-branch

  • Remove the warning box at the top of the guide "In Git, the text of the commit message is part of the commit..." to make it part of the content, and then add the warning box about force pushing.

  • The titles should be changed to:

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 6, 2020
@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core and removed triage Do not begin working on this issue until triaged by the team labels Oct 6, 2020
@Ruth-ikegah
Copy link
Contributor

Hi, @janiceilene I will love to contribute here and take up this issue.

@janiceilene
Copy link
Contributor Author

That sounds great @Ruth-ikegah! Feel free to open a pull request ⚡

@Ruth-ikegah
Copy link
Contributor

Just to be sure, this is the file path for where I am making the changes right: docs/content/github/committing-changes-to-your-project?
Please, I will be asking some questions here if I get stuck. Thanks :)

@Ruth-ikegah
Copy link
Contributor

Hi, @janiceilene I have made a PR.

@janiceilene
Copy link
Contributor Author

This was fixed in #229, so I'm going to close this out 🎉

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
Projects
None yet
Development

No branches or pull requests

2 participants