Skip to content

Latest commit

 

History

History
151 lines (100 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

151 lines (100 loc) · 4.38 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

Pull requests

Installing the source version

To install the source version of Create Client in your project and contribute a patch, run the following commands:

$ git clone git@github.com:api-platform/create-client.git
$ cd create-client
$ yarn install
$ yarn watch

You can now hack in the cloned repository of create-client. If you want to test your work, a lib/index.js file containing your last changes will be created each time you invoke yarn build. You can also use yarn watch to make it created each time a change is performed in your code!

Testing your changes

To test your changes, generate a client in a pwa directory of an api-platform distribution:

$ git clean -df && NODE_TLS_REJECT_UNAUTHORIZED=0 <absolutePathOfYourClonedRepo>/lib/index.js https://localhost/ .

and see the pwa logs:

$ docker-compose logs -f pwa

Before sending a Pull Request, make sure the tests pass correctly:

$ yarn test

Matching coding standards

The style of the project is inspired by the Airbnb JavaScript style guide. But don't worry, you can fix CS issues automatically using ESLint tool:

$ yarn 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 (you can run them using yarn test).
  • Tests are green.
  • You make a PR on the related documentation in the api-platform/doc 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, so he/she will get a notification.
  • Squash your commits into one commit. (see the next chapter)

All Pull Requests must include the following header:

| Q             | A
| ------------- | ---
| Bug fix?      | yes/no
| New feature?  | yes/no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #1234, #5678
| License       | MIT
| Doc PR        | api-platform/doc#1234

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

Tag a new version (contributors only)

Always test before releasing a new one:

$ yarn build
$ yarn test
$ yarn lint

To fix linting errors, you can use yarn fix.

To release a new version:

$ yarn version # this creates a tag
$ git push
$ git push --tags

Travis will then publish the version on npm.

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.