Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.56 KB
Raw

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. 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:

      git clone https://github.com/your-username/repository-name.git

  3. Create a new branch for your contribution:

      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.

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.