Skip to content

Latest commit

 

History

History
137 lines (85 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

137 lines (85 loc) · 4.43 KB
Raw

Contributing to API Platform

First of all, thank you for contributing, you're awesome!

To have your code integrated in the API Platform project, there is some rules to follow, but don't panic, it's easy!

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

Security issues

If you find a security issue, send a mail to Kévin Dunglas dunglas@gmail.com. Please do not report security problems publicly. We will disclose details of the issue and credit you after having released a new version including a fix.

Pull requests

Writing a Pull Request

First of all, you must decide on what branch your changes will be based. If the changes your are going to make are fully backward-compatible, you should base your changes on the latest stable branch (2.0 at the moment). Otherwise, you should base your changes on the master branch.

Matching coding standards

The API Platform project follows Symfony coding standards. But don't worry, you can fix CS issues automatically using the PHP CS Fixer tool

php-cs-fixer.phar fix

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 (Behat and PHPUnit).
  • Tests are green.
  • You make a PR on the related documentation in the api-platform/docs repository.
  • 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 (@dunglas, @sroze or @theofidry), so he/she will get a notification.
  • Squash your commits into one commit. (see the next chapter)

All Pull Requests must include this header.

Tests

On api-platform/core there are two kinds of tests: unit (phpunit) and integration tests (behat).

Both phpunit and behat are development dependencies and should be available in the vendor directory.

Phpunit and coverage generation

To launch unit tests:

vendor/bin/phpunit --stop-on-failure -vvv

If you want coverage, you will need the phpdbg package and run:

phpdbg -qrr vendor/bin/phpunit --coverage-html coverage -vvv --stop-on-failure

Sometimes there might be an error with too many open files when generating coverage. To fix this, you can increase the ulimit, for example:

ulimit -n 4000

Coverage will be available in coverage/index.html.

Behat

The command to launch Behat tests is:

./vendor/bin/behat --stop-on-failure -vvv

You may need to clear the cache manually before running behat tests because of the temporary sql database. To do so, just remove the test cache directory:

rm -r tests/Fixtures/app/cache/test

Squash your commits

If you have 3 commits. So start with:

git rebase -i HEAD~3

An editor will be opened with your 3 commits, all prefixed by pick.

Replace all pick prefixes by fixup (or f) except the first commit of the list.

Save and quit the editor.

After that, all your commits where squashed into the first one and the commit message of the first commit.

If you would like to rename your commit message type:

git commit --amend

Now force push to update your PR:

git push --force

License and copyright attribution

When you open a Pull Request to the API Platform project, you agree to license your code under the MIT license and to transfer the copyright on the submitted code to Kévin Dunglas.

Be sure to you have the right to do that (if you are a professional, ask your company)!

If you include code from another project, please mention it in the Pull Request description and credit the original author.