Skip to content

Commit 41384e4

Browse files
Update CONTRIBUTING.md
Signed-off-by: Marijn van Wezel <[email protected]>
1 parent 42861e9 commit 41384e4

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

.github/CONTRIBUTING.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to php-cypher-dsl
22

3-
Welcome! We look forward to your contributions. This document outlines the guidelines for contributing to php-cypher-dsl. Keep in mind that these are just suggestions, and shouldn't hold you back from making improvements to php-cypher-dsl. Don't be afraid to ignore the rules.
3+
Welcome! We look forward to your contributions. This document outlines the guidelines for contributing to php-cypher-dsl. Keep in mind that these guidelines are mostly just suggestions, and shouldn't hold you back from improving php-cypher-dsl. Don't be afraid to ignore them.
44

55
Below are some examples on how you can contribute:
66

@@ -21,11 +21,10 @@ When submitting code or changes, your submissions will automatically be licensed
2121
In your bug report, you should provide the following:
2222

2323
* A short summary of the bug
24-
* What you expected would happen
24+
* What you expect would happen
2525
* What actually happens
2626
* Steps to reproduce
27-
* Be specific!
28-
* Give sample code if possible.
27+
* Be specific! Give sample code if possible.
2928
* Include the version of PHP and php-cypher-dsl.
3029

3130
You should only report bugs for versions of php-cypher-dsl that [are supported](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md). Please only report bugs if you are using a php-cypher-dsl with a [compatible version of PHP](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md).
@@ -39,7 +38,7 @@ Feel free to propose a new feature by [opening an issue for it](https://github.c
3938
1. Fork the repository.
4039
1. Create a new branch.
4140
1. If you are **implementing new functionality**, create your branch from `development`.
42-
1. If you are **fixing a bug**, create your branch from the oldest branch that is [supported](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md).
41+
1. If you are **fixing a bug**, create your branch from the oldest [supported](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md) branch that is affected by the bug.
4342
1. Implement your change and add tests for it.
4443
1. Make sure the test suite passes.
4544
1. Make sure that the code complies with the coding guidelines (see below).
@@ -56,22 +55,22 @@ Some things to keep in mind:
5655
The branching model used by this project is [gitflow](https://nvie.com/posts/a-successful-git-branching-model/), with the following changes/additions:
5756

5857
1. Feature branches must follow the naming convention `feature/*`.
59-
1. The name of a feature branch should reflect the feature added (e.g. `feature/match-support` instead of `feature/feature-1`).
60-
1. Release branches must follow the naming convention `release/x.y`.
61-
1. Hotfix branches must follow the naming convention `hotfix/x.y.z`.
62-
1. Hotfix branches must branch off from the oldest branch that is [supported](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md).
58+
1. The name of a feature branch should reflect the feature added (e.g. `feature/support-indexing-operator` instead of `feature/feature-1`).
59+
1. Release branches must follow the naming convention `release/x.y`, where `x` and `y` are the major and minor version of the release respectively. A release branch should never be made for a patch.
60+
1. Hotfix branches must follow the naming convention `hotfix/x.y.z`, where `x`, `y` and `z` are the major, minor and patch version of the hot respectively.
61+
1. Hotfix branches must branch off from the oldest [supported](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LIFECYCLE.md) branch that is affected by the bug.
6362
1. Right before a new **major** version is released, a *support* branch is created from `main`.
64-
1. Support branches must follow the naming convention `support/x.y`, where `x.y` is the most recent minor release.
63+
1. Support branches must follow the naming convention `support/x.y`, where `x` and `y` are the major and minor version of the most recent release respectively.
6564

6665
## Coding guidelines
6766

68-
This project comes with a [configuration file](https://github.com/neo4j-php/php-cypher-dsl/blob/main/.php-cs-fixer.dist.php) for php-cs-fixer that you can use to format your code:
67+
This project comes with a [configuration file](https://github.com/neo4j-php/php-cypher-dsl/blob/main/.php-cs-fixer.dist.php) for `php-cs-fixer` that you can use to format your code:
6968

7069
```
7170
$ php vendor/bin/php-cs-fixer fix --config .php-cs-fixer.dist.php
7271
```
7372

74-
This project uses PHPStan for static analysis, which you can use to perform static analysis:
73+
This project uses PHPStan for static analysis:
7574

7675
```
7776
$ php vendor/bin/phpstan
@@ -87,13 +86,19 @@ $ XDEBUG_MODE=coverage php vendor/bin/infection --min-msi=80
8786

8887
## Running test suites
8988

90-
To run all unit tests, use the following command:
89+
To run all tests, use:
90+
91+
```
92+
$ php vendor/bin/phpunit --no-coverage
93+
```
94+
95+
To only run *unit* tests, use:
9196

9297
```
9398
$ php vendor/bin/phpunit --testsuite unit --no-coverage
9499
```
95100

96-
To run all end-to-end tests, use the following command:
101+
To only run *end-to-end* tests, use:
97102

98103
```
99104
$ php vendor/bin/phpunit --testsuite end-to-end --no-coverage

0 commit comments

Comments
 (0)