@@ -73,13 +73,15 @@ Refer to the output of `make help` for a comprehensive list of available command
7373
7474Our project employs [ GitHub Actions] ( https://github.com/features/actions ) for continuous integration, ensuring code quality and reliability. We encourage contributors to review our workflow configurations to understand the CI processes:
7575
76- - [ ` workflows/apply-labels.yml ` ] ( workflows/apply-labels.yml )
77- - [ ` workflows/auto-merge-release.yml ` ] ( workflows/auto-merge-release.yml )
78- - [ ` workflows/coding-standards.yml ` ] ( workflows/coding-standards.yml )
79- - [ ` workflows/create-release.yml ` ] ( workflows/create-release.yml )
80- - [ ` workflows/e2e-macos.yml ` ] ( workflows/e2e-macos.yml ) — ** Currently disabled**
81- - [ ` workflows/e2e-ubuntu.yml ` ] ( workflows/e2e-ubuntu.yml ) — ** Currently disabled**
82- - [ ` workflows/shellcheck.yml ` ] ( workflows/shellcheck.yml )
76+ | Workflow | Description |
77+ | --------------------------------------------------------------| ----------------------------------------------------|
78+ | [ ` apply-labels.yml ` ] ( workflows/apply-labels.yml ) | Auto labels PRs based on rules. |
79+ | [ ` auto-merge-release.yml ` ] ( workflows/auto-merge-release.yml ) | Automatically merges release PRs. |
80+ | [ ` coding-standards.yml ` ] ( workflows/coding-standards.yml ) | Checks ` yaml ` , ` md ` and commit coding standards. |
81+ | [ ` create-release.yml ` ] ( workflows/create-release.yml ) | Creates a new release based on tags. |
82+ | [ ` e2e-macos.yml ` ] ( workflows/e2e-macos.yml ) | End-to-end tests on macOS. ** Currently disabled** |
83+ | [ ` e2e-ubuntu.yml ` ] ( workflows/e2e-ubuntu.yml ) | End-to-end tests on Ubuntu. ** Currently disabled** |
84+ | [ ` shellcheck.yml ` ] ( workflows/shellcheck.yml ) | Lints shell scripts. |
8385
8486<br >
8587
@@ -105,21 +107,21 @@ git commit -am 'fix: something has been fixed'
105107
106108** Allowed Prefixes:**
107109
108- | Prefix | Purpose |
109- | ------------| ---------------------------------------------------------------|
110- | ` feat ` | Introduces a new feature |
111- | ` fix ` | Fixes a bug |
112- | ` perf ` | Improves performance |
113- | ` docs ` | Documentation only changes |
114- | ` style ` | Code style changes (formatting, missing semi-colons, etc.) |
115- | ` deps ` | Updates dependencies |
116- | ` refactor ` | Code changes that neither fixes a bug nor adds a feature |
117- | ` ci ` | Changes to our CI configuration files and scripts |
118- | ` test ` | Adding missing tests or correcting existing tests |
119- | ` revert ` | Reverts a previous commit |
120- | ` build ` | Changes that affect the build system or external dependencies |
121- | ` chore ` | Other changes that don't modify src or test files |
122- | ` security ` | A code change that fixes a security issue |
110+ | Prefix | Purpose |
111+ | ------------- | ---------------------------------------------------------------|
112+ | ` feat: ` | Introduces a new feature |
113+ | ` fix: ` | Fixes a bug |
114+ | ` perf: ` | Improves performance |
115+ | ` docs: ` | Documentation only changes |
116+ | ` style: ` | Code style changes (formatting, missing semi-colons, etc.) |
117+ | ` deps: ` | Updates dependencies |
118+ | ` refactor: ` | Code changes that neither fixes a bug nor adds a feature |
119+ | ` ci: ` | Changes to our CI configuration files and scripts |
120+ | ` test: ` | Adding missing tests or correcting existing tests |
121+ | ` revert: ` | Reverts a previous commit |
122+ | ` build: ` | Changes that affect the build system or external dependencies |
123+ | ` chore: ` | Other changes that don't modify src or test files |
124+ | ` security: ` | A code change that fixes a security issue |
123125
124126<br >
125127
0 commit comments