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

Define quality bands on types and have this reflected in versioning #31

Open
OlafConijn opened this issue Oct 21, 2020 · 0 comments
Open
Labels
question Further information is requested

Comments

@OlafConijn
Copy link
Member

OlafConijn commented Oct 21, 2020

Any type starts with version 0.1.0.
When implementing any of the below, you can increment minor with +1:

Features (use category feat in commit):

  • Implement Create, Update and Delete handler (required minimum -> this is version 0.1.0)
  • Implement Read handler
  • Implement List handler (optional)
  • implement strict mode (optional)

Tests (use category test in commit):

  • Implement automated testing (unit tests)
  • Use and test in a production environment.
  • Use and test in a production environment by someone else.
  • Pass the contract tests.

Example commit message: feat(my-type): implement create/update and delete handler

Breaking changes may occur before 1.0.0.
After 1.0.0 breaking changing only occur when incrementing major.

When squashing PRs use BREAKING CHANGE in the commit body (new line) and add an explanation of breaking changes

see: https://www.conventionalcommits.org/en/v1.0.0-beta.4/
also: https://gist.github.com/PurpleBooth/b24679402957c63ec426

@OlafConijn OlafConijn changed the title define quality bands on types and have this reflected in versioning Define quality bands on types and have this reflected in versioning Oct 21, 2020
@eduardomourar eduardomourar pinned this issue Nov 29, 2020
@eduardomourar eduardomourar added the question Further information is requested label Dec 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants