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 f5169b5

Browse files
chore: add examples to contributing
1 parent 9175b62 commit f5169b5

File tree

2 files changed

+8
-30
lines changed

2 files changed

+8
-30
lines changed

‎CONTRIBUTING.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,17 @@ to read on GitHub as well as in various git tools.
121121
122122
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
123123
124+
125+
Examples:
126+
124127
```
125-
docs(changelog): update changelog to beta.5
126-
```
128+
feat(heap): add error handling for heaps
127129
130+
BREAKING CHANGE: size is now an attribute rather than a method. Similar to the built-in Map.size and Set.size
128131
```
129-
fix(release): need to depend on latest rxjs and zone.js
130132
131-
The version in our package.json gets copied to the one we publish, and users need the latest of these.
133+
```
134+
fix(book/solutions): fix missing solutions
132135
```
133136
134137
### Revert
@@ -184,31 +187,6 @@ Examples of breaking changes include:
184187
* changing the side effects of using a particular API
185188

186189

187-
## Generating Changelog
188-
189-
We use these three sections in changelog: new features, bug fixes, breaking changes.
190-
191-
List of all subjects (First lines in commit message) since last release:
192-
193-
```sh
194-
git log <last tag> HEAD --pretty=format:%s
195-
196-
# example
197-
git log 1.1.0..HEAD --pretty=format:%s
198-
```
199-
200-
New features in this release
201-
202-
```sh
203-
git log <last release> HEAD --grep feat
204-
205-
# examples
206-
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "BREAKING CHANGE:"
207-
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^feat\S*:"
208-
git log 1.2.0..HEAD --pretty=format:"- %s [commit](https://github.com/amejiarosario/dsa.js/commit/%H)" --grep "^fix\S*:"
209-
```
210-
211-
212190
<!-- Examples -->
213191
<!-- https://github.com/nodejs/node/blob/v12.0.0/COLLABORATOR_GUIDE.md -->
214192
<!-- https://github.com/nodejs/node/blob/v12.0.0/doc/guides/writing-and-running-benchmarks.md -->

‎notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ and the meaning the the following:
1010
- Minor: Features (new functionality, adding new topics)
1111
- Patch: Fixes (bug fixes, typos, etc.)
1212

13-
# Generating Changelog
13+
# Generating Changelog (manually) [deprecated]
1414

1515
We use these three sections in changelog: new features, bug fixes, breaking changes.
1616

0 commit comments

Comments
(0)

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