[pull] master from conventional-changelog:master

.codesandbox/ci.json

@@ -0,0 +1,5 @@
+{
+ "node": "18",
+ "packages": ["@alias/*", "@commitlint/*"],
+ "sandboxes": []
+}

.devcontainer/devcontainer.json

@@ -1,13 +1,17 @@
 {
  "name": "commitlint-dev",
- "dockerComposeFile": ["../docker-compose.yml"],
+ "dockerComposeFile": ["../compose.yaml"],
  "service": "commitlint",
  "workspaceFolder": "/root/repo",
  "shutdownAction": "stopCompose",
- "extensions": [
- "editorconfig.editorconfig",
- "ms-vsliveshare.vsliveshare-pack",
- "ms-azuretools.vscode-docker",
- "esbenp.prettier-vscode"
- ]
+ "customizations": {
+ "vscode": {
+ "extensions": [
+ "editorconfig.editorconfig",
+ "esbenp.prettier-vscode",
+ "ms-azuretools.vscode-docker",
+ "ms-vsliveshare.vsliveshare-pack"
+ ]
+ }
+ }
 }

.github/CONTRIBUTING.md

@@ -38,7 +38,7 @@ Please consider these guidelines when filing a pull request:
  _ What you added
  _ What you removed
 
-## Coding Rules
+### Coding Rules
 
 To keep the code base of commitlint neat and tidy the following rules apply to every change
 
@@ -48,7 +48,7 @@ To keep the code base of commitlint neat and tidy the following rules apply to e
 - Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra)
 - Be awesome
 
-## Commit Rules
+### Commit Rules
 
 To help everyone with understanding the commit history of commitlint the following commit rules are enforced.
 To make your life easier commitlint is commitizen-friendly and provides the npm run-script `commit`.
@@ -60,3 +60,121 @@ To make your life easier commitlint is commitizen-friendly and provides the npm
 - present tense
 - maximum of 100 characters
 - message format of `$type($scope): $message`
+
+### Environment setup
+
+This project uses `yarn`, so be sure that it is available in your shell environment.
+
+After cloning the repo run
+
+```sh
+yarn install
+```
+
+### Testing
+
+From the project root directory, use the following commands to run the test suite
+
+```sh
+yarn build
+yarn test
+```
+
+### Documentation updates
+
+Documentation uses `vitepress`.
+To run and edit the documentation locally run:
+
+```sh
+yarn docs-dev
+```
+
+To have a preview of the deployed doc run:
+
+```sh
+yarn docs-build
+yarn docs-serve
+```
+
+For more information refer to [vitepress documentation](https://vitepress.dev).
+
+## Package dependency overview
+
+![commitlint-dependencies](https://user-images.githubusercontent.com/4248851/58385093-34b79780-7feb-11e9-8f27-bffc4aca3eba.png)
+
+(Partly outdated)
+
+## Publishing a release
+
+```sh
+npm login
+nvm use (if you have nvm installed)
+```
+
+- [nvm](https://github.com/nvm-sh/nvm)
+- [asdf](https://asdf-vm.com/) is supported as well
+
+```sh
+yarn clean
+yarn install
+yarn build
+yarn test
+yarn run publish --otp <one-time password>
+```
+
+If something in between fails (like a new package was added and needs to be published for the
+first time but you forgot) you can use `lerna publish from-package` to publish anything that
+has not been published yet.
+
+### Create GitHub release
+
+1. Copy changelog entry for the new version
+1. Create release for the new tag: https://github.com/conventional-changelog/commitlint/releases
+1. Post in the [commitlint Slack-channel][12]
+
+### Publish a `next` release (or i.e. patch release)
+
+```sh
+npm login
+nvm use (if you have nvm installed)
+```
+
+```sh
+yarn clean
+yarn install
+yarn build
+yarn test
+npx lerna publish --conventional-commits --dist-tag [`next` | `next` | `[release-vXX(BRANCH)]`] --otp <one-time password>
+```
+
+If for some reason this stops in between, you can manually publish missing packages like this:
+
+```sh
+npm publish <package-name> --tag [`latest` | `next` | `[release-vXX(BRANCH)]`] --otp <one-time password>
+```
+
+Depending on the state of the packages you might need to run `npm pack` in each failed package and then publish it.
+
+#### Publishing (new) packages for the first time
+
+```sh
+npm publish [PACKAGE_NAME] --access public
+```
+
+From within the folder first i.e. `cd @commitlint/new-packages`.
+
+#### Move `next` to `latest`
+
+```sh
+npm login
+```
+
+```sh
+npx lerna exec --no-bail --no-private --no-sort --stream -- '[ -n "$(npm v . dist-tags.next)" ] && npm dist-tag add ${LERNA_PACKAGE_NAME}@$(npm v . dist-tags.next) latest --otp <one-time password>'
+```
+
+Remove next:
+
+```sh
+npx lerna exec --no-bail --no-private --no-sort --stream -- '[ -n "$(npm v . dist-tags.next)" ] && npm dist-tag rm ${LERNA_PACKAGE_NAME} next --otp <one-time password>'
+```

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -1,31 +1,42 @@
-name: '🐛 Bug Report'
+name: "🐛 Bug Report"
 description: Create a new ticket for a bug.
-title: 'fix: <title>'
-labels: ['bug']
+title: "fix: <title>"
+labels: ["bug"]
 body:
  - type: markdown
  attributes:
  value: |
  Provide a general summary of the issue in the Title above
  - type: textarea
- id: expected-behavior
+ id: steps-to-reproduce
  attributes:
- label: 'Expected Behavior'
- description: Tell us what should happen
- placeholder: Short and explicit description of your incident...
+ label: "Steps to Reproduce"
+ description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant
+ value: |
+ 1. First step
+ 2. Second step
+ render: bash
  validations:
  required: true
  - type: textarea
  id: current-behavior
  attributes:
- label: 'Current Behavior'
+ label: "Current Behavior"
  description: Tell us what happens instead of the expected behavior
  validations:
  required: false
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: "Expected Behavior"
+ description: Tell us what should happen
+ placeholder: Short and explicit description of your incident...
+ validations:
+ required: true
  - type: checkboxes
  id: affected-packages
  attributes:
- label: 'Affected packages'
+ label: "Affected packages"
  options:
  - label: cli
  - label: core
@@ -34,25 +45,14 @@ body:
  - type: textarea
  id: possible-solution
  attributes:
- label: 'Possible Solution'
+ label: "Possible Solution"
  description: Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change
  validations:
  required: false
- - type: textarea
- id: steps-to-reproduce
- attributes:
- label: 'Steps to Reproduce'
- description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant
- value: |
- 1. First step
- 2. Second step
- render: bash
- validations:
- required: true
  - type: textarea
  id: context
  attributes:
- label: 'Context'
+ label: "Context"
  description: |
  How has this issue affected you? What are you trying to accomplish?
  Providing context helps us come up with a solution that is most useful in the real world
@@ -61,21 +61,21 @@ body:
  - type: input
  id: commitlint-version
  attributes:
- label: 'commitlint --version'
- placeholder: '@commitlint/cli@x.x.x'
+ label: "commitlint --version"
+ placeholder: "@commitlint/cli@x.x.x"
  validations:
  required: true
  - type: input
  id: git-version
  attributes:
- label: 'git --version'
+ label: "git --version"
  placeholder: vx.x.x
  validations:
  required: true
  - type: input
  id: node-version
  attributes:
- label: 'node --version'
+ label: "node --version"
  placeholder: vx.x.x
  validations:
  required: true