Skip to content

Commit

Permalink
feat: add explanation about commit message in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
CBID2 committed Nov 14, 2023
1 parent 4db0c98 commit d076161
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,29 +99,30 @@ First, you'll want to have Node.js installed. You can do this by going to [nodej
7. If you used the CLI tool method in step 5 to add yourself to the guest book, **skip this step**. Otherwise:
Add and commit your changes by running this command:
Add and commit your changes by running the following command:
```bash
git commit -am "Your message"
```
Change `"Your message"` to your own message. For example, `"Add Alice as a contributor"`.
Unlike the `git add .` and `git commit -m "Your message"` approach, the `git commit -am` command skips the staging process. This is because its use of `-a` automatically stage the changes you made via Git.
8. Run `git log` to check if you have committed your changes. Press `Q` to close the log.
1. Run `git log` to check if you have committed your changes. Press `Q` to close the log.
If you add yourself using the CLI tool, it automatically adds and commits your changes. So you will see this automated commit message:
```bash
docs: add @your_username as a contributor
```
9. Push the commit to your forked repository with this command:
2. Push the commit to your forked repository with this command:
```bash
git push -u origin branch-name
```
10. Go to your forked repository on GitHub and [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) with the title `feat: Add <@github-username> as a contributor`.
3. Go to your forked repository on GitHub and [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) with the title `feat: Add <@github-username> as a contributor`.
## Keeping Branch Up to Date and Resolving Merge Conflicts
Expand Down

0 comments on commit d076161

Please sign in to comment.