The basis for the development of projects.
Download this zip archive or clone this repository (Git required) to your computer.
Then:
$ cd initial-project-basis
- go inside the project directory;$ npm install
- install dependencies.
Command line:
$ npm run format
- format all code in files according to a pattern (**/*.{json,yml,md}
);$ npm run format:check
- check whether there is unformatted code in files (**/*.{json,yml,md}
).
In addition, the code formatting check ($ npm run format:check
) is performed in the pre-commit hook.
Checking a commit message is done using the commitlint module. Rules for validation correspond to conventional commit specification.
Commitlint.io (online generator) is used to create and pre-check the text of the commit message.
Workflow:
- make changes;
- commit those changes;
- pull all the tags (optional);
$ npm version [patch|minor|major]
- run the command;- push commits and tags to remote repository.
If you find a bug or something does not work, please leave your questions or comments on issues.
This software is released under the terms of the MIT license.