-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md remove empty links for plugins and advanced methods * task: add CONTRIBUTING.md file * remove local files from commit
- Loading branch information
1 parent
941078d
commit 052fe12
Showing
2 changed files
with
37 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
#Contributing | ||
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. | ||
|
||
|
||
### Commit message convention | ||
|
||
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages: | ||
|
||
- `fix`: bug fixes, e.g. fix crash due to deprecated method. | ||
- `feat`: new features, e.g. add new method to the module. | ||
- `refactor`: code refactor, e.g. migrate from class components to hooks. | ||
- `docs`: changes into documentation, e.g. add usage example for the module.. | ||
- `test`: adding or updating tests, eg add integration tests using detox. | ||
- `chore`: tooling changes, e.g. change CI config. | ||
|
||
Our pre-commit hooks verify that your commit message matches this format when committing. | ||
|
||
|
||
### Sending a pull request | ||
|
||
> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). | ||
When you're sending a pull request: | ||
|
||
- Prefer small pull requests focused on one change. | ||
- Verify that linters and tests are passing. | ||
- Review the documentation to make sure it looks good. | ||
- Follow the pull request template when opening a pull request. | ||
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters