From 77b23245c54ae68fc66b96e8e03ba686c724230d Mon Sep 17 00:00:00 2001 From: Vincent Amstoutz Date: Fri, 4 Oct 2024 09:38:05 +0200 Subject: [PATCH] docs: add CONTRIBUTING.md file --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..2be61f563bd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to the API Platform Documentation + +First of all, thank you for contributing, you're awesome! + +To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy! + +## Reporting Bugs in the documentation + +Before submitting your issue: + +* Check if the bug is not already reported! +* A clear title to resume the issue +* A description of the workflow needed to reproduce the bug + +> [!NOTE] +> Don't hesitate giving as much information as you can. + +## Code of Conduct + +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. + +## How to Contribute + +1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page. + +2. Clone the forked repository to your local machine: + ```bash + git clone https://github.com/your-username/repository-name.git + ``` +3. Create a new branch for your contribution: + ```bash + git switch -c docs-your-branch-name + ``` +4. Commit and push your changes +5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change. + See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/). + +> [!TIP] +> You can also contribute to improving the documentation directly by clicking on the +> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page.