From 60caa27a65bfec182081af073fe17eb079f16fee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Torres?= <30977845+Torres-ssf@users.noreply.github.com> Date: Thu, 16 Jan 2025 10:10:09 -0300 Subject: [PATCH] chore: adjust commit conventions (#3595) --- .changeset/wet-goats-push.md | 4 ++++ .github/workflows/pr-lint.yaml | 2 +- CONTRIBUTING.md | 4 +--- 3 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 .changeset/wet-goats-push.md diff --git a/.changeset/wet-goats-push.md b/.changeset/wet-goats-push.md new file mode 100644 index 00000000000..9b649cfc997 --- /dev/null +++ b/.changeset/wet-goats-push.md @@ -0,0 +1,4 @@ +--- +--- + +chore: adjust commit conventions diff --git a/.github/workflows/pr-lint.yaml b/.github/workflows/pr-lint.yaml index 7601e770a80..6c5ccfb7c88 100644 --- a/.github/workflows/pr-lint.yaml +++ b/.github/workflows/pr-lint.yaml @@ -39,10 +39,10 @@ jobs: feat fix chore + test build docs ci - rc - name: Check PR title length env: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7d90e864f5..47e456266ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -228,7 +228,6 @@ pnpm bench:node pnpm bench:node packages/my-desired-package ``` - ### CI Test During the CI process an automated end-to-end (e2e) test is executed. This test is crucial as it simulates real-world scenarios on the current test-net, ensuring that the changeset maintains the expected functionality and stability. @@ -268,11 +267,10 @@ When you create a commit we kindly ask you to follow the convention `category(scope or module): message` in your commit message while using one of the following categories: -- `feat / feature`: all changes that introduce completely new code or new +- `feat`: all changes that introduce completely new code or new features - `fix`: changes that fix a bug (ideally you will additionally reference an issue if present) -- `refactor`: any code related change that is not a fix nor a feature - `docs`: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage) - `build`: all changes regarding the build of the software, changes to