From c043ffc907bec42c7dbcafa4d7032b3795ff1db4 Mon Sep 17 00:00:00 2001 From: psyko-gh Date: Wed, 21 Aug 2024 21:00:54 +0200 Subject: [PATCH] chore: added CONTRIBUTING.md --- .commitlintrc.yaml | 1 + CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.commitlintrc.yaml b/.commitlintrc.yaml index 9cb74a7..91c031c 100644 --- a/.commitlintrc.yaml +++ b/.commitlintrc.yaml @@ -1,2 +1,3 @@ extends: - "@commitlint/config-conventional" +defaultIgnores: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..74ebd19 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +## Commit messages + +Commit messages should respect the [Conventinal Commits](https://www.conventionalcommits.org/) convention + +``` +[optional scope]: + +[optional body] + +[optional footer(s)] +``` + +### type +``` + chore Updating tasks etc (no production code change) + build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) + ci Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) + docs Documentation only changes + feat A new feature + fix A bug fix + perf A code change that improves performance + refactor A code change that neither fixes a bug nor adds a feature + style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) + test Adding missing tests or correcting existing tests + revert A commit revert +``` + +### body + +Indicate a breaking change should be done in the body + +``` +chore!: drop support for Node 6 + +BREAKING CHANGE: use JavaScript features not available in Node 6. +```