variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Docs: Add CONTRIBUTING.md

Browse source
This commit is contained in:
Aria Minaei 2021-06-21 14:06:23 +02:00
parent 6596c811d7
commit 80e22342f1
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,26 @@
# Contributing to Theatre.js
>`@todo` Write the contribution guide.
## Commit messages
Our commit message format is as follows:
```
[Tag]: Short description (fixes #1234)
Longer description here if necessary
```
The first line of the commit message (the summary) must have a specific format. This format is checked by our build tools.
The `[Tag]` is one of the following:
* `Fix` - for a bug fix.
* `Update` - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
* `New` - implemented a new feature.
* `Breaking` - for a backwards-incompatible enhancement or feature.
* `Docs` - changes to documentation only.
* `Build` - changes to build process only.
* `Upgrade` - for a dependency upgrade.
* `Chore` - for refactoring, adding tests, etc. (anything that isn't user-facing).