aws-resource-providers icon indicating copy to clipboard operation
aws-resource-providers copied to clipboard

Define quality bands on types and have this reflected in versioning

Open OlafConijn opened this issue 4 years ago • 0 comments

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 avatar Oct 21 '20 12:10 OlafConijn