|
2 | 2 |
|
3 | 3 | First of all, thank you for contributing, you're awesome!
|
4 | 4 |
|
5 |
| -To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy! |
| 5 | +To have your code integrated in the API Platform documentation project, there |
| 6 | +are some rules to follow, but don't panic, it's easy! |
6 | 7 |
|
7 | 8 | ## Reporting Bugs in the documentation
|
8 | 9 |
|
9 | 10 | Before submitting your issue:
|
10 | 11 |
|
11 |
| -- Check if the bug is not already reported! |
12 |
| -- A clear title to resume the issue |
13 |
| -- A description of the workflow needed to reproduce the bug |
| 12 | +- Check if the bug is not already reported! |
| 13 | +- A clear title to resume the issue |
| 14 | +- A description of the workflow needed to reproduce the bug |
14 | 15 |
|
15 |
| -> [!NOTE] |
16 |
| -> Don't hesitate giving as much information as you can. |
| 16 | +> [!NOTE] Don't hesitate giving as much information as you can. |
17 | 17 |
|
18 | 18 | ## Code of Conduct
|
19 | 19 |
|
20 |
| -By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/api-platform/docs#contributor-code-of-conduct). We expect all contributors to foster a welcoming and inclusive environment. |
| 20 | +By contributing to this project, you agree to abide by our |
| 21 | +[Code of Conduct](https://github.com/api-platform/docs#contributor-code-of-conduct). |
| 22 | +We expect all contributors to foster a welcoming and inclusive environment. |
21 | 23 |
|
22 | 24 | ## How to Contribute
|
23 | 25 |
|
24 |
| -1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page. |
| 26 | +1. Fork this repository by clicking the "Fork" button at the top right of the |
| 27 | + `api-platform/docs` repository page. |
25 | 28 |
|
26 | 29 | 2. Clone the forked repository to your local machine:
|
27 |
| - ```bash |
28 |
| - git clone https://github.com/your-username/repository-name.git |
29 |
| - ``` |
| 30 | + ```bash |
| 31 | + git clone https://github.com/your-username/repository-name.git |
| 32 | + ``` |
30 | 33 | 3. Create a new branch for your contribution:
|
31 |
| - ```bash |
32 |
| - git switch -c docs-your-branch-name |
33 |
| - ``` |
| 34 | + ```bash |
| 35 | + git switch -c docs-your-branch-name |
| 36 | + ``` |
34 | 37 | 4. Commit and push your changes
|
35 |
| -5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change. |
36 |
| - See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/). |
| 38 | +5. Submit a Pull Request. You must decide on what branch your changes will be |
| 39 | + based depending of the nature of the change. See |
| 40 | + [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/). |
37 | 41 |
|
38 |
| -> [!TIP] |
39 |
| -> You can also contribute to improving the documentation directly by clicking on the |
40 |
| -> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page. |
| 42 | +> [!TIP] You can also contribute to improving the documentation directly by |
| 43 | +> clicking on the **"You can also help us improve the documentation of this |
| 44 | +> page."** link, located at the end of each documentation page. |
0 commit comments