You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-9Lines changed: 8 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ First of all, thank you for contributing, you're awesome!
4
4
5
5
To have your code integrated in the API Platform project, there is some rules to follow, but don't panic, it's easy!
6
6
7
-
## Reporting bugs
7
+
## Reporting Bugs
8
8
9
9
If you happen to find a bug, we kindly request you to report it. However, before submitting it, please:
10
10
@@ -27,11 +27,10 @@ publicly**. We will disclose details of the issue and credit you after having re
27
27
28
28
### Writing a Pull Request
29
29
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/).
33
32
34
-
### Matching coding standards
33
+
### Matching Coding Standards
35
34
36
35
The API Platform project follows [Symfony coding standards](https://symfony.com/doc/current/contributing/code/standards.html).
37
36
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:
52
51
* You make a PR on the related documentation in the [api-platform/docs](https://github.com/api-platform/docs) repository.
53
52
* You make the PR on the same branch you based your changes on. If you see commits
54
53
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.
56
55
* Squash your commits into one commit. (see the next chapter)
57
56
58
57
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
63
62
64
63
Both `phpunit` and `behat` are development dependencies and should be available in the `vendor` directory.
65
64
66
-
#### Phpunit and coverage generation
65
+
#### Phpunit and Coverage Generation
67
66
68
67
To launch unit tests:
69
68
@@ -93,7 +92,7 @@ The command to launch Behat tests is:
0 commit comments