Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upRe-organize Changing a commit message documentation #158
Comments
Hi, @janiceilene I will love to contribute here and take up this issue. |
That sounds great @Ruth-ikegah! Feel free to open a pull request |
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? |
Hi, @janiceilene I have made a PR. |
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:
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: