Skip to content

Commit

Permalink
docs: simplify commit instruction (#346)
Browse files Browse the repository at this point in the history
prefer `git commit` without `-m` as it forces you to think about the
commit message. `git add .` is also a bit dangerous since you can
accidentally add files you did not mean to add. `git commit -a` rather
only adds changes tracked files.
  • Loading branch information
charles-cooper authored Nov 22, 2024
1 parent a1cddb3 commit a843212
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ git checkout -b <branch_name>
And start making your changes! Once you're done, you can commit your changes and push them to your forked repo.

```bash
git add .
git commit -m 'your commit message'
git commit -a
git push <your_forked_github>
```

Expand Down

0 comments on commit a843212

Please sign in to comment.