Merge pull request #88 from neo4j-php/hotfix/add-contributing-md

Add a CONTRIBUTING.md document

.github/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing to php-cypher-dsl
+
+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.
+
+Below are some examples on how you can contribute:
+
+* [Report a bug](https://github.com/neo4j-php/php-cypher-dsl/issues/new?template=bug_report.md)
+* [Propose a new feature](https://github.com/neo4j-php/php-cypher-dsl/issues/new?template=missing_feature_request.md)
+* [Send a pull request](https://github.com/neo4j-php/php-cypher-dsl/pulls)
+
+## Code of conduct
+
+This project has a [Contributor Code of Conduct](https://github.com/neo4j-php/php-cypher-dsl/blob/main/CODE_OF_CONDUCT.md). By contributing to or participating in this project, you agree to abide to its terms.
+
+## Any contributions will be licensed under the GPL 2.0 or any later version
+
+When submitting code or changes, your submissions will automatically be licensed under the [GNU General Public License](https://github.com/neo4j-php/php-cypher-dsl/blob/main/LICENSE) version 2.0 or later. By contributing to this project, you agree that your contributions will be licensed under its terms.
+
+## Writing bug reports
+
+In your bug report, you should provide the following:
+
+* A short summary of the bug
+* What you expect would happen
+* What actually happens
+* Steps to reproduce
+  * Be specific! Give sample code if possible.
+  * Include the version of PHP and php-cypher-dsl.
+
+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).
+
+## Proposing new features
+
+Feel free to propose a new feature by [opening an issue for it](https://github.com/neo4j-php/php-cypher-dsl/issues/new?template=missing_feature_request.md).
+
+## Workflow for pull requests
+
+1. Fork the repository.
+1. Create a new branch.
+   1. If you are **implementing new functionality**, create your branch from `development`.
+   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.
+1. Implement your change and add tests for it.
+1. Make sure the test suite passes.
+1. Make sure that the code complies with the coding guidelines (see below).
+1. Submit your pull request!
+
+Some things to keep in mind:
+
+* Make sure that you have [configured a user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git.
+* Keep backwards compatibility breaks to a minimum.
+* You are encouraged to [sign your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) with GPG.
+
+## Branching model
+
+The branching model used by this project is [gitflow](https://nvie.com/posts/a-successful-git-branching-model/), with the following changes/additions:
+
+1. Feature branches must follow the naming convention `feature/*`.
+1. The name of a feature branch should reflect the feature added (e.g. `feature/support-indexing-operator` instead of `feature/feature-1`).
+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.
+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. 
+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.
+1. Right before a new **major** version is released, a *support* branch is created from `main`.
+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.
+
+## Coding guidelines
+
+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:
+
+```
+$ php vendor/bin/php-cs-fixer fix --config .php-cs-fixer.dist.php
+```
+
+This project uses PHPStan for static analysis:
+
+```
+$ php vendor/bin/phpstan
+```
+
+After making your changes and adding your tests, you can check whether the minimum coverage and minimum mutation score indicator requirements are still met:
+
+```
+$ XDEBUG_MODE=coverage php vendor/bin/phpunit --testsuite unit
+$ php vendor/bin/coverage-check coverage/clover.xml 90
+$ XDEBUG_MODE=coverage php vendor/bin/infection --min-msi=80
+```
+
+## Running test suites
+
+To run all tests, use:
+
+```
+$ php vendor/bin/phpunit --no-coverage
+```
+
+To only run *unit* tests, use:
+
+```
+$ php vendor/bin/phpunit --testsuite unit --no-coverage
+```
+
+To only run *end-to-end* tests, use:
+
+```
+$ php vendor/bin/phpunit --testsuite end-to-end --no-coverage
+```

README.md

@@ -24,6 +24,10 @@ command:
 composer require "wikibase-solutions/php-cypher-dsl"
 ```
 
+## Contributing
+
+Please refer to [CONTRIBUTING.md](https://github.com/neo4j-php/php-cypher-dsl/blob/main/.github/CONTRIBUTING.md) for information on how to contribute to this project.
+
 ## Example
 
 To construct a query to find all of Tom Hanks' co-actors, you can use the