Skip to content

Files

Latest commit

 

History

History
90 lines (65 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

90 lines (65 loc) · 3.68 KB

Contributing

Thank you for contributing. Contributions are always welcome, no matter how large or small.

Table of Contents


Guidelines

As a contributor, here are the guidelines you should follow:

We also recommend to read How to Contribute to Open Source.


Pull Requests

Thank you for contributing.


Clone the Repository

git clone git@github.com:github.com/seantrane/commitlint-config-awesome.git commitlint-config-awesome && cd commitlint-config-awesome

Install Dependencies

# Install dependecies:
npm install
# Link npm package to your global namespace:
npm link

Dependency Links


File Structure

commitlint-config-awesome/
 ├─ .markdownlint.yaml         * markdown lint rules and config
 ├─ .travis.yml                * CI/CD config
 ├─ CODEOWNERS                 * default pull-request reviewers
 ├─ CONTRIBUTING.md            * contributing guidelines
 ├─ CHANGLOG.md                * changelog autogenerated by `@semantic-release/changelog`
 ├─ index.js                   * commitlint configuration file
 ├─ package-lock.json          * npm package dependency lock file
 ├─ package.json               * npm package config
 └─ README.md                  * package readme

Happy coding!