Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 1.93 KB
Raw

Sonata respects the symfony’s conventions about contributing to the code. So before going further please review the contributing documentation of Symfony.

Reporting bugs

If you happen to find a bug, we kindly request you to report it. However, before submitting it, please:

Then, if it appears that it’s a real bug, you may report it using Github by following these 3 points:

  • 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 (OS, PHP version extensions …)

Pull requests

Matching coding standards

Before each commit, be sure to match sonata coding standards by running the following command for fix:

make cs

And then, add fixed file to your commit before push.

Be sure to add only your modified files. If another files are fixed by cs tools, just revert it before commit.

Sending a Pull Request

When you send a PR, just make sure that:

  • You add valid test cases.
  • Tests are green.
  • The related documentation is up-to-date.
  • You make the PR on the same branch you based your changes on. If you see commits that you did not make in your PR, you're doing it wrong.
  • Also don't forget to add a comment when you update a PR with a ping to the maintainer (@username), so he/she will get a notification.

Contributing to the documentation

You need to install the python tool to check and validate the sphinx syntax:

pip install -r Resources/doc/requirements.txt

and you can check the documentation with the command:

cd Resources/doc/
rm -rf _build && sphinx-build -W -b html -d _build/doctrees   . _build/html

The html will be available in the _build/html folder.