-
-
Notifications
You must be signed in to change notification settings - Fork 362
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add conventional commits. fix #230
- Loading branch information
Showing
3 changed files
with
23 additions
and
2 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,19 @@ | ||
# Contributing Guide | ||
|
||
Thanks for lending a hand 👋 | ||
|
||
Here are a few ways to contribute: | ||
|
||
- [Add a theme](./docs/themes.md#adding-theme) | ||
- [Add a language grammar](./docs/languages.md#adding-grammar) | ||
- Fix a bug | ||
|
||
## Coding conventions | ||
|
||
- We use [prettier](https://prettier.io). Before you commit, all files will be formatted automatically. | ||
- We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please use a prefix. If your PR has multiple commits and some of them don't follow the Conventional Commits rule, we'll do a squash merge. | ||
|
||
## Fix a bug | ||
|
||
- Reference the bug you are fixing in the PR | ||
- Add a test if possible |
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
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