This is a baseline starter project providing documents that are commonly used in Github Flow open source projects. It has the following features:
- MIT Licence
- Contributor Covenant Code of Conduct
- Contribution Guidelines
- Guidelines for Seeking Help
- Guidelines for Extending This Project
- Release and Changelog Automation with Release It!
- Commit Linting with commitlint
- Husky for triggering commit linting and on commit test automation and linting for projects extending this one.
This starter project is setup to make following the Conventional Commits Specification for adding human and machine readable meaning to commit messages easy.
Following the convention allows for proper use of the Semantic Versioning Specification and also enables automatic generation of the projects changelog ( CHANGELOG.md).
This projects includes release-it which will automatically generate the CHANGELOG.md file when running npm run release.
To get started extending this project see the Guidelines for Extending This Project.