Thank you for contributing. Contributions are always welcome, no matter how large or small.
As a contributor, here are the guidelines you should follow:
- Code of conduct
- How can I contribute?
- Using the issue tracker
- Submitting a Pull Request
- Coding rules
- Working with code
We also recommend to read How to Contribute to Open Source.
Thank you for contributing.
- Create your branch from
master
. - Ensure your git commit messages follow the required format.
- Ensure your scripts are well-formed, well-documented and object-oriented.
- Ensure your scripts are stateless and can be reused by all.
- Update your branch, and resolve any conflicts, before making pull request.
- Fill in the required template.
- Do not include issue numbers in the PR title.
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the style guide applicable to the language or task.
- Include thoughtfully-worded, well-structured tests/specs. See the Tests/Specs Style Guide.
- Document new code based on the Documentation Style Guide.
- End all files with a newline.
git clone git@github.com:github.com/seantrane/commitlint-config-awesome.git commitlint-config-awesome && cd commitlint-config-awesome
# Install dependecies:
npm install
# Link npm package to your global namespace:
npm link
- commitlint: Lint commit messages
- husky: Git hooks made easy
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