Merge pull request #190 from toniperic/contribution

Versioning and contribution documentation

Author: HypeMC

CHANGELOG.md

@@ -2,7 +2,7 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+and this project [adheres to Semantic Versioning, but only for the public API](README.md#versioning).
 
 ## [3.1.1] - 2020-04-10
 ### Removed

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+
+All contributions are **welcome** and **very much appreciated**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/trikoder/oauth2-bundle).
+
+## Pull Request guidelines
+
+- **Add tests!** - We strongly encourage adding tests as well since the PR might not be accepted without them.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+## Development
+
+[Docker](https://www.docker.com/) 18.03+ and [Docker Compose](https://github.com/docker/compose) 1.13+ are required for the development environment.
+
+### Building the environment
+
+Make sure your Docker images are all built and up-to-date using the following command:
+
+```sh
+dev/bin/docker-compose build
+```
+
+> **NOTE:** You can target a different version of PHP during development by appending the `--build-arg PHP_VERSION=<version>` argument.
+
+After that, install all the needed packages required to develop the project:
+
+```sh
+dev/bin/php composer install
+```
+
+### Debugging
+
+You can run the debugger using the following command:
+
+```sh
+dev/bin/php-debug vendor/bin/phpunit
+```
+
+Make sure your IDE is setup properly, for more information check out the [dedicated documentation](docs/debugging.md).
+
+### Code linting
+
+This bundle enforces the PSR-2 and Symfony code standards during development by using the [PHP CS Fixer](https://cs.sensiolabs.org/) utility. Before committing any code, you can run the utility to fix any potential rule violations:
+
+```sh
+dev/bin/php composer lint
+```
+
+### Testing
+
+You can run the whole test suite using the following command:
+
+```sh
+dev/bin/php-test composer test
+```
+
+**Happy coding**!

README.md

@@ -153,51 +153,15 @@ security:
 * [Password grant handling](docs/password-grant-handling.md)
 * [Implementing custom grant type](docs/implementing-custom-grant-type.md)
 
-## Development
+## Contributing
 
-[Docker](https://www.docker.com/) 18.03+ and [Docker Compose](https://github.com/docker/compose) 1.13+ are required for the development environment.
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-### Building the environment
+## Versioning
 
-Make sure your Docker images are all built and up-to-date using the following command:
+This project adheres to [Semantic Versioning 2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
 
-```sh
-dev/bin/docker-compose build
-```
-
-> **NOTE:** You can target a different version of PHP during development by appending the `--build-arg PHP_VERSION=<version>` argument.
-
-After that, install all the needed packages required to develop the project:
-
-```sh
-dev/bin/php composer install
-```
-
-### Testing
-
-You can run the test suite using the following command:
-
-```sh
-dev/bin/php-test composer test
-```
-
-### Debugging
-
-You can run the debugger using the following command:
-
-```sh
-dev/bin/php-debug vendor/bin/phpunit
-```
-
-Make sure your IDE is setup properly, for more information check out the [dedicated documentation](docs/debugging.md).
-
-### Code linting
-
-This bundle enforces the PSR-2 and Symfony code standards during development using the [PHP CS Fixer](https://cs.sensiolabs.org/) utility. Before committing any code, you can run the utility so it can fix any potential rule violations for you:
-
-```sh
-dev/bin/php composer lint
-```
+However, starting with version 4, we only promise to follow SemVer on structural elements marked with the [@api tag](https://github.com/php-fig/fig-standards/blob/2668020622d9d9eaf11d403bc1d26664dfc3ef8e/proposed/phpdoc-tags.md#51-api).
 
 ## Changes