Skip to content

Commit

Permalink
chore: add conventional commits. fix #230
Browse files Browse the repository at this point in the history
  • Loading branch information
octref committed Sep 16, 2021
1 parent 49edb78 commit 6782a9e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.md
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
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
- [ ] Add a test if possible
- [ ] Format all commit messages with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

<!-- If fixing a bug -->

- [ ] This PR fixes #
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,7 @@ Clone [shikijs/shiki-starter](https://github.com/shikijs/shiki-starter) to play

## Contributing

- [Add a theme](./docs/themes.md#adding-theme)
- [Add a language grammar](./docs/languages.md#adding-grammar)
See the [Contributing Guide](.github/CONTRIBUTING.md).

## Credits

Expand Down

0 comments on commit 6782a9e

Please sign in to comment.