chore: 🔧switched to standard-version (#15)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,7 @@
 ## React Boilerplate CRA Template
 
+### ⚠️ Clear this template before you submit (after you read the things below)
+
 Thank you for contributing! Please take a moment to review our [**contributing guidelines**](https://github.com/react-boilerplate/react-boilerplate/blob/master/CONTRIBUTING.md)
 to make the process easy and effective for everyone involved.
 

.github/workflows/commitlint.yaml

@@ -0,0 +1,31 @@
+# Run commitlint on Pull Requests and commits
+name: commitlint
+on:
+  pull_request:
+      types: ['opened', 'edited', 'reopened', 'synchronize']
+  push:
+      branches:
+        - master
+        - dev
+
+jobs:
+  lint-pull-request-name:
+    # Only on pull requests
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - run: npm i @commitlint/config-conventional
+      - uses: JulienKode/pull-request-name-linter-action@v0.1.2
+  lint-commits:
+    # Only if we are pushing or merging PR to the master
+    if: (github.event_name == 'pull_request' && github.base_ref == 'refs/heads/master') || github.event_name == 'push'
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 30 # Its fine to lint last 30 commits only
+      - run: npm i @commitlint/config-conventional
+      - uses: wagoid/commitlint-github-action@v1

.github/workflows/lint.yml

@@ -9,12 +9,3 @@ jobs:
       - uses: actions/checkout@v2
       - run: npm i # There is a bug with npm ci -> https://github.com/npm/cli/issues/558
       - run: npm run lint
-  commitlint:
-    runs-on: ubuntu-latest
-    env:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - uses: wagoid/commitlint-github-action@v1

.versionrc.js

@@ -0,0 +1,34 @@
+const internalSection = `_Internals (This section should NOT concern the template users)_`;
+/*
+ * Used for creating CHANGELOG.md automatically.
+ * Anything under the internalSection should be boilerplate internals
+ * and shouldn't interest the end users, meaning that the template shouldn't be effected.
+ */
+
+// Check the descriptions of the types -> https://github.com/commitizen/conventional-commit-types/blob/master/index.json
+module.exports = {
+  types: [
+    { type: 'feat', section: 'Features', hidden: false },
+    { type: 'fix', section: 'Bug Fixes', hidden: false },
+    { type: 'docs', section: 'Documentation', hidden: false },
+    { type: 'perf', section: 'Performance Updates', hidden: false },
+
+    // Other changes that don't modify src or test files
+    { type: 'chore', section: internalSection, hidden: false },
+
+    // Adding missing tests or correcting existing tests
+    { type: 'test', section: internalSection, hidden: false },
+
+    // Changes to our CI configuration files and scripts
+    { type: 'ci', section: internalSection, hidden: false },
+
+    // A code change that neither fixes a bug nor adds a feature
+    { type: 'refactor', section: internalSection, hidden: false },
+
+    // Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+    { type: 'style', section: internalSection, hidden: false },
+  ],
+  skip: {
+    commit: true,
+  },
+};

CONTRIBUTING.md

@@ -94,11 +94,23 @@ Since the `master` branch is what people actually use in production, we have a
 consider that stable we merge it into the `master` branch and release the
 changes for real.
 
-⚠️ **WARNING**
+## Commit Messages
 
-This project uses [commitlint](https://github.com/conventional-changelog/commitlint) for formating the commit messages. Check [here](https://www.conventionalcommits.org/en/v1.0.0/) for understanding the commit message format.
+This project uses [commitlint](https://github.com/conventional-changelog/commitlint) for formating the commit messages. Check [here](https://www.conventionalcommits.org/en/v1.0.0/) for understanding the commit message format (or take a look at our commit history).
 
-> List of available [commit types](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)
+Pull Requests are squashed merged, so you don't have to use this format for your commits. Git hook is only running if you are commit to the `dev` branch directly. However, your PR title will be checked and you can see the results in the status checks for your PR
+
+In short PR title must follow the format
+
+```
+<type>[optional scope]: <description>
+```
+
+where `type` can be one of the followings in [.versionrc.js](./.versionrc.js)
+
+Those commits will be used to generate [CHANGELOG.md](./CHANGELOG.md) automatically before the releases.
+
+> More info: [standard-version](https://github.com/conventional-changelog/standard-version)
 
 **IMPORTANT**: By submitting a patch, you agree to allow the project
 owners to license your work under the terms of the [MIT License](https://github.com/react-boilerplate/react-boilerplate/blob/master/LICENSE.md).

commitlint.config.js

@@ -1 +1,10 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };
+// Use types from .versionrc.js so that when generating CHANGELOG there are no inconsistencies
+const standardVersionTypes = require('./.versionrc').types;
+const typeEnums = standardVersionTypes.map(t => t.type);
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [2, 'always', typeEnums],
+  },
+};