Skip to content

Commit 0ea4fab

Browse files
type: [docs], message: Add pre-commit installation instructions
1 parent b4ac813 commit 0ea4fab

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -78,30 +78,32 @@ setup(
7878
)
7979
```
8080

81-
### Adding pre-commit message lint
81+
### Adding pre-commit message CLI
8282

83-
The semantic-release `pre-commit message lint` will validate your commit messages before the commit being accepted.
84-
That will prevent you from having to rebase your commit history to adapt your commit messages to semantic-release standards.
83+
The `pre-commit` will validate your commit messages before the commit being accepted.
84+
That will prevent you from having to rebase your commit history to adapt your commit messages to [semantic-release](https://github.com/NeowayLabs/semantic-release) standards.
8585

86-
Notes:
87-
1. To activate commit message template in a pre-existing local repository, go to the project root folder and run `git init` command.
88-
2. After `make commit-message-install`, Git will automatically activate commit message template to new cloned projects.
86+
**Requirements**
87+
- [Golang installation](https://go.dev/doc/install)
8988

90-
Run the following command:
89+
90+
Clone pre-commit project and install it in you SO.
9191

9292
```
93-
make commit-message-install
93+
git clone [email protected]:NeowayLabs/pre-commit.git
9494
```
9595
96-
If for some reason you need to skip commit lint, you can run git commit with the `--no-verify` tag as follows.
97-
9896
```
99-
git commit -m "type: [typo], message: We do not recommend doing this!" --no-verify
97+
make install
10098
```
10199
102-
We do not recommind using `--no-verify` for projects that use [commit lint ci step](#how-to-add-commit-lint-stage-to-gitlab) once it will validate all the branche commit messages.
100+
**How to use it?**
101+
102+
After adding new changes with the `git add` command, you can run `commit` on any git project root path and follow CLI steps.
103103
104-
If at least one commit message breaks semantic-release standards, you'll have to rebase and reword the wrong commit messages.
104+
```
105+
commit
106+
```
105107
106108
### How to use `rebase` to rename commit message?
107109

0 commit comments

Comments
 (0)