|
| 1 | +# Contributing |
1 | 2 |
|
2 |
| -## Commit message convention |
| 3 | +Thank you for considering contributing to this project! |
3 | 4 |
|
4 |
| -Commit messages must follow our convention based on the |
5 |
| -[Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message) |
6 |
| -or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html): |
| 5 | +We provide a guide for contributors. If you are reading this locally or directly on GitHub, check the following documents: |
7 | 6 |
|
8 |
| -``` |
9 |
| -<type>[(scope)]: Subject |
| 7 | +- Contributors guide: [docs/guide/contributors.md](docs/guide/contributors.md) |
| 8 | + - Environment setup: [docs/guide/contributors/setup.md](docs/guide/contributors/setup.md) |
| 9 | + - Management commands: [docs/guide/contributors/commands.md](docs/guide/contributors/commands.md) |
| 10 | + - Development workflow: [docs/guide/contributors/workflow.md](docs/guide/contributors/workflow.md) |
| 11 | + - Project architecture: [docs/guide/contributors/architecture.md](docs/guide/contributors/architecture.md) |
10 | 12 |
|
11 |
| -[Body] |
12 |
| -``` |
13 |
| - |
14 |
| -**Subject and body must be valid Markdown.** |
15 |
| -Subject must have proper casing (uppercase for first letter |
16 |
| -if it makes sense), but no dot at the end, and no punctuation |
17 |
| -in general. |
18 |
| - |
19 |
| -Scope and body are optional. Type can be: |
20 |
| - |
21 |
| -- `build`: About packaging, building wheels, etc. |
22 |
| -- `chore`: About packaging or repo/files management. |
23 |
| -- `ci`: About Continuous Integration. |
24 |
| -- `deps`: Dependencies update. |
25 |
| -- `docs`: About documentation. |
26 |
| -- `feat`: New feature. |
27 |
| -- `fix`: Bug fix. |
28 |
| -- `perf`: About performance. |
29 |
| -- `refactor`: Changes that are not features or bug fixes. |
30 |
| -- `style`: A change in code style/format. |
31 |
| -- `tests`: About tests. |
32 |
| - |
33 |
| -If you write a body, please add trailers at the end |
34 |
| -(for example issues and PR references, or co-authors), |
35 |
| -without relying on GitHub's flavored Markdown: |
36 |
| - |
37 |
| -``` |
38 |
| -Body. |
39 |
| -
|
40 |
| -Issue #10: https://github.com/namespace/project/issues/10 |
41 |
| -Related to PR namespace/other-project#15: https://github.com/namespace/other-project/pull/15 |
42 |
| -``` |
43 |
| - |
44 |
| -These "trailers" must appear at the end of the body, |
45 |
| -without any blank lines between them. The trailer title |
46 |
| -can contain any character except colons `:`. |
47 |
| -We expect a full URI for each trailer, not just GitHub autolinks |
48 |
| -(for example, full GitHub URLs for commits and issues, |
49 |
| -not the hash or the #issue-number). |
50 |
| - |
51 |
| -We do not enforce a line length on commit messages summary and body, |
52 |
| -but please avoid very long summaries, and very long lines in the body, |
53 |
| -unless they are part of code blocks that must not be wrapped. |
54 |
| - |
55 |
| -## Pull requests guidelines |
56 |
| - |
57 |
| -Link to any related issue in the Pull Request message. |
58 |
| - |
59 |
| -During the review, we recommend using fixups: |
60 |
| - |
61 |
| -```bash |
62 |
| -# SHA is the SHA of the commit you want to fix |
63 |
| -git commit --fixup=SHA |
64 |
| -``` |
65 |
| - |
66 |
| -Once all the changes are approved, you can squash your commits: |
67 |
| - |
68 |
| -```bash |
69 |
| -git rebase -i --autosquash main |
70 |
| -``` |
71 |
| - |
72 |
| -And force-push: |
73 |
| - |
74 |
| -```bash |
75 |
| -git push -f |
76 |
| -``` |
77 |
| - |
78 |
| -If this seems all too complicated, you can push or force-push each new commit, |
79 |
| -and we will squash them ourselves if needed, before merging. |
| 13 | +However we strongly recommend reading the online version at https://mkdocstrings.github.io/griffe/guide/contributors/, as some content is dynamically generated when building the documentation pages. |
0 commit comments