Skip to content

Developpers recommandations

Allan Cueff edited this page Jan 25, 2023 · 2 revisions

Useful commands

Start the bot

npm start

Test the code syntax before starting the bot

npm test

Verifies the syntax only

npm lint

Commit syntax

Developpers MUST write commits messages with knowledge of how auto versioning works

Developpers SHOULD use a prompt (under 50 characters) description of changes as commit message first line.

First line MAY NOT be a complete & constructed sentence. Linking word as determiners or pronouns or punctuation MAY be omitted when not useful to comprehension. Verbs MAY be infinitive or participle form only.

Developpers SHOULD describe precisely commit upgrades in others lines than the first

Developpers MAY add a type : [major|minor|patch|typo] line to commit message

Auto version

Each commit message is analyzed to determine how to increment the project version as specified under Semantic Versioning 2.0.0

  • Major version number will be incremented when strings major or breaking change are found in commit message
  • Minor version number will be incremented when strings minor or feat(feature) are found in commit message
  • Patch version number will be incremented in all cases

To prevent version update add string [no-upgrade] or [no-version] to commit message

Clone this wiki locally