Skip to content

Commit d3e41ea

Browse files
docs: clarify commit and PR title guidelines (#207)
1 parent 44109d9 commit d3e41ea

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,42 @@ tox --colored yes --stderr-color RESET -r -e "$TOX_ENV" -vvv
101101
Similarly, you can test different Python versions by changing `py310` to `py311`
102102
or `py312`.
103103

104+
## Commit and PR title guidelines
105+
106+
We require commits and PR titles to conform to the
107+
[conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/)
108+
and follow the
109+
[Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).
110+
In a nutshell, the commit message should be structured as follows:
111+
112+
> [!TIP]
113+
>
114+
> It is highly recommended to include the scope in the PR title and in all the
115+
> commits
116+
117+
```plaintext
118+
<type>[optional scope]: <description>
119+
120+
[optional body]
121+
122+
[optional footer(s)]
123+
```
124+
125+
Where `type` is one of the following:
126+
127+
- **build**: Changes that affect the build system (e.g., pyproject.toml files,
128+
Dockerfiles, etc.) or external dependencies.
129+
- **ci**: Changes to CI-related configuration files and scripts
130+
- **docs**: Documentation only changes
131+
- **feat**: A new feature
132+
- **fix**: A bug fix
133+
- **perf**: A code change that improves performance
134+
- **refactor**: A code change that neither fixes a bug nor adds a feature
135+
- **style**: Changes that do not affect the meaning of the code (white-space,
136+
formatting, etc)
137+
- **test**: Adding missing tests or correcting existing tests
138+
- **chore** (discouraged): Minor changes that don't fit in other categories
139+
104140
## Coding style guidelines
105141

106142
We require code and markup to adhere to certain rules. We enforce these rules

0 commit comments

Comments
 (0)