-
Notifications
You must be signed in to change notification settings - Fork 5
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
semantic-release needs to be documented well. Specially the case where the first commit to master (as it is configured to act on master in our repo) will create release 1.0.0. Their convention varies as they claim 0.1.0 is not well defined and npm starts versioning at 1.0.0. However they provide pre-release guidelines:
We need to make this explicitly clear to developers as this first release as 1.0.0 can come as a surprise. Ideally a working example should be provided.
The blog post they reference:
https://blog.greenkeeper.io/introduction-to-semver-d272990c44f2
Additionally, provide them with instructions for setting up tooling to follow commit message standards via https://commitizen-tools.github.io/commitizen/
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation