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: .github/CONTRIBUTING.md
+19-14Lines changed: 19 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing to php-cypher-dsl
2
2
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.
4
4
5
5
Below are some examples on how you can contribute:
6
6
@@ -21,11 +21,10 @@ When submitting code or changes, your submissions will automatically be licensed
21
21
In your bug report, you should provide the following:
22
22
23
23
* A short summary of the bug
24
-
* What you expected would happen
24
+
* What you expect would happen
25
25
* What actually happens
26
26
* Steps to reproduce
27
-
* Be specific!
28
-
* Give sample code if possible.
27
+
* Be specific! Give sample code if possible.
29
28
* Include the version of PHP and php-cypher-dsl.
30
29
31
30
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
39
38
1. Fork the repository.
40
39
1. Create a new branch.
41
40
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.
43
42
1. Implement your change and add tests for it.
44
43
1. Make sure the test suite passes.
45
44
1. Make sure that the code complies with the coding guidelines (see below).
@@ -56,22 +55,22 @@ Some things to keep in mind:
56
55
The branching model used by this project is [gitflow](https://nvie.com/posts/a-successful-git-branching-model/), with the following changes/additions:
57
56
58
57
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.
63
62
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.
65
64
66
65
## Coding guidelines
67
66
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:
0 commit comments