Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 5339a27

Browse files
docs(contributing): clarify git commits format
1 parent 9bb9577 commit 5339a27

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

‎CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,16 +127,15 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow
127127
### Type
128128
Must be one of the following:
129129
130-
* **break**: Breaking changes. Remove functionality or change API. Breaks backward compatibility
131130
* **feat**: A new feature
132131
* **fix**: A bug fix
132+
* **docs**: Documentation only changes
133133
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
134134
* **ci**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
135-
* **docs**: Documentation only changes
136-
* **perf**: A code change that improves performance
135+
* **test**: Adding missing tests or correcting existing tests
137136
* **refactor**: A code change that neither fixes a bug nor adds a feature
138137
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
139-
* **test**: Adding missing tests or correcting existing tests
138+
* **perf**: A code change that improves performance
140139
141140
### Scope
142141
The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
@@ -190,8 +189,8 @@ New features in this release
190189
```sh
191190
git log <last release> HEAD --grep feat
192191
193-
# example
194-
git log 6.0.0..HEAD --pretty=format:%s |grep feat
195-
#
196-
git log 6.0.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" |grep feat
192+
# examples
193+
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "BREAKING CHANGE:"
194+
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^feat\S*:"
195+
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix\S*:"
197196
```

‎notes.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ git log <last tag> HEAD --pretty=format:%s
2222
# example
2323
git log 1.1.0..HEAD --pretty=format:%s
2424

25-
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix.*:"
26-
27-
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^break.*:"
28-
25+
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "BREAKING CHANGE:"
2926
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^feat.*:"
27+
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix.*:"
3028
```
3129

3230
New features in this release

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /