Skip to content

chore: add standard-version and release script #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

- Removed support for Node.js 6, 7 and 8 - all of which are EOL at this point. Travis CI modified to test on Node.js 10 and 12.

### Added

- Added support for standard-version and conventional-changelog

## [1.0.0]

### Added
Expand Down
24 changes: 22 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,35 @@ ahead of `master`.

## Changelog

Always update the [CHANGELOG.md](./CHANGELOG.md), following
[this semantics](https://keepachangelog.com/en/1.0.0/).
The [CHANGELOG.md](./CHANGELOG.md) will be updated with your commits if you format
your commit messages following the
[Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary).
If you are unsure what prefix to use for a commit, you can consult the
[package.json](https://github.com/cloudevents/sdk-javascript/blob/master/package.json) file
in this repository. In the `standard-version.types` section, you can see all of the commit
types that will be committed to the changelog based on the prefix in the first line of
your commit message. For example, the commit message:

```log
fix: removed a bug that was causing the rotation of the earth to change
```

will show up in the "Bug Fixes" section of the changelog for a given release.

## Pull Requests

Guidelines about how to perform pull requests.

- before submit the PR, open an issue and link them

### Commit Messages

Please follow the Conventional Commits specification noted above. the first line of
your commit should be prefixed with a type, be a single sentence with no period, and
succinctly indicate what this commit changes.

All commit message lines should be kept to fewer than 80 characters if possible.

### PR to `develop`

- fixes in the documentation (readme, contributors)
Expand Down
Loading