First of all, thanks for thinking of contributing to this project! 👏
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
As a contributor, here are the guidelines we would like you to follow:
- Table of Contents
- Code of Conduct
- How can I contribute?
- Using the issue tracker
- Submitting a Pull Request
- Style Guides
We also recommend that you read How to Contribute to Open Source.
Please note that this project have a code of conduct, please follow it in all your interactions with the project.
Some issues are created without information requested in the Bug report guideline. Help make them easier to resolve by adding any relevant information.
Issues with the enhancement label are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence our future direction.
Confirmed bugs and ready-to-implement features are marked with the help wanted label. Post a comment on an issue to indicate you would like to work on it and to request help from the maintainers and the community.
The issue tracker is the channel for bug reports, features requests and submitting pull requests only.
Before opening an issue or a Pull Request, please use the GitHub issue search to make sure the bug or feature request hasn't been already reported or fixed.
A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the Bug report template.
Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the Feature request template.
Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
If you have never created a pull request before, welcome 🎉 😄. Here is a great tutorial on how to send one. 😃
This is our preferred process for opening a PR on GitHub:
- Fork this repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
-
Try to keep the existing code style. Please don't reformat or change the syntax of existing code simply because you don't like that style.
-
Indentation is using spaces, not tabs. Most of the code is indented with 2 spaces, some with 4 spaces. Please try to keep 2 spaces. If you are using an editor that supports EditorConfig, the editor should automatically use the settings defined in our .editorconfig file.
-
Use
bashbuilt-ins wherever possible. -
Use snake_case for function and variable names.
-
Quote EVERYTHING.
For your contribution to be accepted, your changes need to pass ShellCheck.
shellcheck file.shNote: If you have trouble installing ShellCheck. You can open a pull request on the repo and our GitHub Actions will run ShellCheck for you.
This project uses the conventional commit for your commit messages. This format is used to generate changelogs and ensures consistency and better filtering.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
The footer can contain a closing reference to an issue.
Revert
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Type
Must be one of the following:
| Type | Description |
|---|---|
build |
Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
chore |
Used when changes are about organization, not about logic. |
ci |
Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
docs |
Documentation only changes. |
feat |
A new feature. |
fix |
A bug fix. |
perf |
A code change that improves performance. |
refactor |
A code change that neither fixes a bug nor adds a feature. |
revert |
Reverts a previous commit. |
style |
Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
test |
Adding missing tests or correcting existing tests. |
Subject
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Body Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Footer The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
Examples
fix(pencil): stop graphite breaking when too much pressure applied
feat(pencil): add 'graphiteWidth' option
Fix #42
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.