Skip to content

Commit d22857d

Browse files
authored
Update CONTRIBUTING.md
1 parent 4af8c78 commit d22857d

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ First of all, thank you for contributing, you're awesome!
44

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

7-
## Reporting bugs
7+
## Reporting Bugs
88

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

@@ -27,11 +27,10 @@ publicly**. We will disclose details of the issue and credit you after having re
2727

2828
### Writing a Pull Request
2929

30-
First of all, you must decide on what branch your changes will be based. If the changes your are going to make are
31-
fully backward-compatible, you should base your changes on the latest stable branch (`2.0` at the moment).
32-
Otherwise, you should base your changes on the `master` branch.
30+
First of all, you must decide on what branch your changes will be based depending of the nature of the change.
31+
See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
3332

34-
### Matching coding standards
33+
### Matching Coding Standards
3534

3635
The API Platform project follows [Symfony coding standards](https://symfony.com/doc/current/contributing/code/standards.html).
3736
But don't worry, you can fix CS issues automatically using the [PHP CS Fixer](http://cs.sensiolabs.org/) tool
@@ -52,7 +51,7 @@ When you send a PR, just make sure that:
5251
* You make a PR on the related documentation in the [api-platform/docs](https://github.com/api-platform/docs) repository.
5352
* You make the PR on the same branch you based your changes on. If you see commits
5453
that you did not make in your PR, you're doing it wrong.
55-
* 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.
54+
* Also don't forget to add a comment when you update a PR with a ping to [the maintainers](https://github.com/orgs/api-platform/people), so he/she will get a notification.
5655
* Squash your commits into one commit. (see the next chapter)
5756

5857
All Pull Requests must include [this header](.github/PULL_REQUEST_TEMPLATE.md).
@@ -63,7 +62,7 @@ On `api-platform/core` there are two kinds of tests: unit (`phpunit`) and integr
6362

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

66-
#### Phpunit and coverage generation
65+
#### Phpunit and Coverage Generation
6766

6867
To launch unit tests:
6968

@@ -93,7 +92,7 @@ The command to launch Behat tests is:
9392
./vendor/bin/behat --suite=default --stop-on-failure -vvv
9493
```
9594

96-
## Squash your commits
95+
## Squash your Commits
9796

9897
If you have 3 commits. So start with:
9998

@@ -121,7 +120,7 @@ Now force push to update your PR:
121120
git push --force
122121
```
123122

124-
# License and copyright attribution
123+
# License and Copyright Attribution
125124

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

0 commit comments

Comments
 (0)