Skip to content
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

Introduce Changelog and PR template #765

Merged
merged 8 commits into from Jun 11, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
Thank you for your contribution!

Check the following boxes:

- [ ] Wrote [good commit messages][1].
- [ ] Feature branch is up-to-date with `master` (if not - rebase it).
- [ ] Squashed related commits together.
- [ ] Added tests.
- [ ] Added an entry to the [Changelog](../blob/master/CHANGELOG.md) if the new
code introduces user-observable changes.
- [ ] The PR relates to *only* one subject with a clear title
and description in grammatically correct, complete sentences.
jaredbeck marked this conversation as resolved.
Show resolved Hide resolved

[1]: http://chris.beams.io/posts/git-commit/
jaredbeck marked this conversation as resolved.
Show resolved Hide resolved
53 changes: 53 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,53 @@
# Changelog

Notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

In SemVer, changes to dependencies (e.g. dropping EoL rubies)
are [not necessarily considered breaking][1].

jaredbeck marked this conversation as resolved.
Show resolved Hide resolved
## Unreleased

### Breaking Changes

- None

### Added

- None

### Fixed

- None

## 3.0.0 - 2020-06-10

### Breaking Changes

- None
jaredbeck marked this conversation as resolved.
Show resolved Hide resolved

### Added

- Cucumber 4 support (#762)

### Fixed

- Fix a bundler deprecation when running specs (#761)
- remove name override logic that never worked (#758)

### Dependencies

- Drop ruby 2.3 support (#760)
- Drop ruby 2.2 support (#759)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe just list these under breaking ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to move them if you want. In my own projects, I don't like to set the expectation that dependency updates will always mean major bumps. And, SemVer does not consider dependency updates to be breaking changes (as long as the public API stays the same).


## 2.0.0 - 2015-11-19

No docs yet. Contributions welcome!

## 1.0.0 - 2014-06-07

No docs yet. Contributions welcome!
jaredbeck marked this conversation as resolved.
Show resolved Hide resolved

[1] https://semver.org/#what-should-i-do-if-i-update-my-own-dependencies-without-changing-the-public-api
jaredbeck marked this conversation as resolved.
Show resolved Hide resolved