Create CONTRIBUTING.md (#42)

fixes #40
package-url · Jan 4, 2022 · d012a70 · d012a70
1 parent 98918ba
commit d012a70
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 18 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Contributing 
+
+Feel free to open pull requests.
+
+## Setup 
+
+To start developing simply run `composer run-script dev-setup` to install dev-dependencies and tools.
+
+## Tests
+
+Make sure
+
+* to run `composer run-script cs-fix` to have the coding standards applied.
+* to run `composer run-script test` and pass all tests.
diff --git a/README.md b/README.md
@@ -44,29 +44,15 @@ $purl2 = PackageUrl::fromString($purlString);
 var_dump($purl == $purl2);
 ```
 
-## Run tests
+## Contributing
 
-install setup and tools:
-
-```shell
-composer dev-setup
-```
-
-fix code styles:
-
-```shell
-composer cs-fix
-```
-
-run tests:
-
-```shell
-composer test
-```
+Feel free to open pull requests.  
+See the [contribution docs][contributing_file] for details.
 
 [package url spec]: https://github.com/package-url/purl-spec
 
 [license_file]: https://github.com/package-url/packageurl-php/blob/main/LICENSE
+[contributing_file]: https://github.com/package-url/packageurl-php/blob/main/CONTRIBUTING.md
 
 [shield_gh-workflow-test]: https://img.shields.io/github/workflow/status/package-url/packageurl-php/PHP%20CI/main?logo=GitHub&logoColor=white "build"
 [shield_packagist-version]: https://img.shields.io/packagist/v/package-url/packageurl-php?logo=&logoColor=white "packagist"