docs: add contributing doc

3 years ago · f6e4fd1ba9
parent d306319de1
commit f6e4fd1ba9
1 changed files with 10 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,10 @@
+# Commit Type Guideline
+  * build: changes that affect the build system or external dependencies (example scopes: npm, pip, rg)
+  * ci: changes to CI configuration files and scripts (example scopes: format, lint, issue_templates)
+  * docs: changes to the documentation only
+  * feat: new feature for the user
+  * fix: bug fix
+  * perf: performance improvement
+  * refactor: code change that neither fixes a bug nor adds a feature
+  * test: adding missing tests or correcting existing tests
+  * chore: all the rest, including version bump for plugins