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
+28-22Lines changed: 28 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,28 @@
2
2
3
3
First of all, thank you for contributing, you're awesome!
4
4
5
-
To have your code integrated in the API Platform project, there is some rules to follow, but don't panic, it's easy!
5
+
To have your code integrated in the API Platform project, there are some rules to follow, but don't panic, it's easy!
6
6
7
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
11
11
* Check the [project documentation available online](https://api-platform.com/docs/)
12
12
13
-
Then, if it appears that it's a real bug, you may report it using Github by following these 3 points:
13
+
Then, if it appears that it's a real bug, you may report it using GitHub by following these 3 points:
14
14
15
15
* Check if the bug is not already reported!
16
16
* A clear title to resume the issue
17
17
* A description of the workflow needed to reproduce the bug
18
18
19
-
> _NOTE:_ Don’t hesitate giving as much information as you can (OS, PHP version extensions...)
19
+
> _NOTE:_ Don't hesitate giving as much information as you can (OS, PHP version extensions...)
20
20
21
-
### Security issues
21
+
### Security Issues
22
22
23
23
If you find a security issue, send a mail to Kévin Dunglas <[email protected]>. **Please do not report security problems
24
24
publicly**. We will disclose details of the issue and credit you after having released a new version including a fix.
25
25
26
-
## Pull requests
26
+
## Pull Requests
27
27
28
28
### Writing a Pull Request
29
29
@@ -33,14 +33,14 @@ See [the dedicated documentation entry](https://api-platform.com/docs/extra/rele
33
33
### Matching Coding Standards
34
34
35
35
The API Platform project follows [Symfony coding standards](https://symfony.com/doc/current/contributing/code/standards.html).
36
-
But don't worry, you can fix CS issues automatically using the [PHP CS Fixer](http://cs.sensiolabs.org/) tool
36
+
But don't worry, you can fix CS issues automatically using the [PHP CS Fixer](http://cs.sensiolabs.org/) tool:
37
37
38
-
```bash
38
+
```shell
39
39
php-cs-fixer.phar fix
40
40
```
41
41
42
-
And then, add fixed file to your commit before push.
43
-
Be sure to add only **your modified files**. If another files are fixed by cs tools, just revert it before commit.
42
+
And then, add the fixed file to your commit before pushing.
43
+
Be sure to add only **your modified files**. If any other file is fixed by cs tools, just revert it before committing.
44
44
45
45
### Sending a Pull Request
46
46
@@ -52,7 +52,7 @@ When you send a PR, just make sure that:
52
52
* You make the PR on the same branch you based your changes on. If you see commits
53
53
that you did not make in your PR, you're doing it wrong.
54
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.
55
-
* Squash your commits into one commit. (see the next chapter)
55
+
* Squash your commits into one commit (see the next chapter).
56
56
57
57
All Pull Requests must include [this header](.github/PULL_REQUEST_TEMPLATE.md).
58
58
@@ -62,23 +62,23 @@ On `api-platform/core` there are two kinds of tests: unit (`phpunit`) and integr
62
62
63
63
Both `phpunit` and `behat` are development dependencies and should be available in the `vendor` directory.
64
64
65
-
#### Phpunit and Coverage Generation
65
+
#### PHPUnit and Coverage Generation
66
66
67
67
To launch unit tests:
68
68
69
-
```
69
+
```shell
70
70
vendor/bin/phpunit --stop-on-failure -vvv
71
71
```
72
72
73
73
If you want coverage, you will need the `phpdbg` package and run:
- "#Call to method PHPUnit\\\\Framework\\\\Assert::assertSame\\(\\) with array\\('(collection_context|item_context|subresource_context)'\\) and array<Symfony\\\\Component\\\\VarDumper\\\\Cloner\\\\Data>\\|bool\\|float\\|int\\|string\\|null will always evaluate to false\\.#"
@trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), E_USER_DEPRECATED);
45
+
@trigger_error(sprintf('Not injecting %s in the IdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), E_USER_DEPRECATED);
0 commit comments