Skip to content

Commit 4881e9e

Browse files
docs: add CONTRIBUTING.md file (#2029)
1 parent 8742b52 commit 4881e9e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to the API Platform Documentation
2+
3+
First of all, thank you for contributing, you're awesome!
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!
6+
7+
## Reporting Bugs in the documentation
8+
9+
Before submitting your issue:
10+
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
14+
15+
> [!NOTE]
16+
> Don't hesitate giving as much information as you can.
17+
18+
## Code of Conduct
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.
21+
22+
## How to Contribute
23+
24+
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
25+
26+
2. Clone the forked repository to your local machine:
27+
```bash
28+
git clone https://github.com/your-username/repository-name.git
29+
```
30+
3. Create a new branch for your contribution:
31+
```bash
32+
git switch -c docs-your-branch-name
33+
```
34+
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/).
37+
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.

0 commit comments

Comments
 (0)