Skip to content
This repository was archived by the owner on Oct 2, 2019. It is now read-only.

Commit 435d321

Browse files
committed
chore(contributing): update contributing document
1 parent c79f0c8 commit 435d321

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,11 @@ we use the git commit messages to **generate the change log**.
2121
## Recommended workflow
2222

2323
1. Make changes
24-
2. Run `gulp` or `gulp test` to run Karma tests.
25-
3. If tests pass, commit those changes using the conventions below.
26-
4. Run `gulp bump` to update the version in package.json, add a git tag and generate the updated CHANGELOG.md.
27-
5. `conventionalChangelog` (see https://github.com/ajoslin/conventional-changelog)
28-
6. Commit updated `package.json` and `CHANGELOG.md` files
29-
7. Push
30-
8. Create PR
31-
32-
The reason why you should commit and tag after `conventionalChangelog` is that the CHANGELOG should be included in the new release, hence `gitRawCommitsOpts.from` defaults to the latest semver tag.
33-
34-
This process is automated with gulp, including determining the type of version to bump (major, minor or patch). To use Gulp, follow these steps:
35-
36-
1. Complete a feature or bug
37-
2. Commit the changes
38-
3. Run `gulp bump` (this will bump the version in package.json, run conventional-changelog to update the changelog and tag the version.
39-
4. Push
24+
2. Run `gulp` or `gulp test` to run Karma tests and ensure they pass.
25+
3. Reset all `dist/*` files
26+
4. Commit changes using the commit message conventions below.
27+
5. Push
28+
6. Create PR
4029

4130
### Commit Message Format
4231
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special

0 commit comments

Comments
 (0)