@etfdev/commitlint-config v0.1.0
About the Project
An opinionated collection of Commitlint rules. To be imported into other projects or used as a boilerplate for further Commitlint configurations.
Built With
The following tools and packages were used to build this project:
- Commitlint A static code analysis tool for identifying problematic patterns found in JavaScript code
- Node.js A JavaScript runtime built on Chrome's V8 JavaScript engine
Getting Started
Prerequisites
- Commitlint
npm install commitlint@latest --global
- NPM
npm install npm@latest --global
Installation
- Install the package dependencies into the project
npm install commitlint --save-dev
- Install the package into the project
npm install @etfdev/commitlint-config --save-dev
Usage
- Create an Commitlint configuration file (if one does not already exist)
touch .commitlintrc.js
Edit / Update the Commitlint configuration file to include the following
module.exports = { ... extends : [ ... '@etfdev' ] ... }
Roadmap
See the open issues for a list of proposed features (and known issues)
Contributing
Contributions are what make the open source community such an amazing place to learn, create and be inspired.
Any contributions you make are grearly appreciated.
Contribution Policies
Before contributing, be sure to review the contributing policies
Contribution Guide
- Fork the Project
- Create your Feature Branch
git checkout -b feature/AmazingFeature
- Commit your changes
git commit -m 'Add some AmazingFeature'
- Push to the Branch
- Open a Pull Request
Versioning
We use Semantic Versioning for versioning.
For the versions available, see the tags on this repository.
License
Distributed under the MIT License. See LICENSE
file for more details.
Contact
Eric Fledderman - @ericfledderman - ericfledderman@me.com
Project Link: https://github.com/ericfledderman/commitlint-config
Acknowledgements
- Choose a License Non-judgmental guidance on choosing a license for your open source project
- Img Shields Legible & concise status badges for third-party codebase services
3 years ago