From 80e22342f1bdef6343204684d260973e06e81e23 Mon Sep 17 00:00:00 2001 From: Aria Minaei Date: Mon, 21 Jun 2021 14:06:23 +0200 Subject: [PATCH] Docs: Add CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b8cb7b2 --- /dev/null +++ b/CONTRIBUTING.md @@ -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). \ No newline at end of file