Add CONTRIBUTING.md

Author: scheb

.gitattributes

@@ -8,6 +8,7 @@
 /.php_cs.dist export-ignore
 /.scrutinizer.yml export-ignore
 /.travis.yml export-ignore
+/CONTRIBUTING.md export-ignore
 /LICENSE export-ignore
 /phpunit.xml.dist export-ignore
 /README.md export-ignore

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+Contributing
+============
+👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+
+Submitting a Bug Report
+-----------------------
+
+Before you report a bug, please check the [troubleshooting guide](Resources/doc/troubleshooting.md) first.
+
+When creating the bug report, please follow the bug template and provide details about the Symfony and bundle version
+you're using.
+
+Creating a Pull Request
+-----------------------
+
+You're welcome to [contribute](https://github.com/scheb/two-factor-bundle/graphs/contributors) new features by creating
+a pull requests or feature request in the issues section. Besides new features, [translations](Resources/translations)
+are highly welcome.
+
+For pull requests, please follow these guidelines:
+
+- Symfony code style
+- PHP7.1 type hints for everything (including: return types, `void`, nullable types)
+- Please add/update test cases
+- Test methods should be named `[method]_[scenario]_[expected result]`
+
+### Running Quality Checks
+
+Before you create a pull request, please make sure your changes fulfill the
+
+1) Install the dependencies with `composer install`
+2) Run the PHPUnit tests with `bin/phpunit`

README.md

@@ -13,6 +13,7 @@ This bundle provides **[two-factor authentication](https://en.wikipedia.org/wiki
 
 It comes with the following two-factor authentication methods:
 
+- [TOTP authentication](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm)
 - [Google Authenticator](https://en.wikipedia.org/wiki/Google_Authenticator)
 - Authentication code via email
 
@@ -61,19 +62,10 @@ authentication. ([#143](https://github.com/scheb/two-factor-bundle/issues/143))
 - Before versions 3.26.0 / 4.11.0 it was possible to bypass two-factor authentication when the remember-me option is
 available on the login form. ([#253](https://github.com/scheb/two-factor-bundle/issues/253))
 
-Contribute
-----------
-You're welcome to [contribute](https://github.com/scheb/two-factor-bundle/graphs/contributors) to this bundle by
-creating a pull requests or feature request in the issues section. For pull requests, please follow these guidelines:
+Contributing
+------------
 
-- Symfony code style
-- PHP7.1 type hints for everything (including: return types, `void`, nullable types)
-- Please add/update test cases
-- Test methods should be named `[method]_[scenario]_[expected result]`
-
-Besides new features, [translations](Resources/translations) are highly welcome.
-
-To run the test suite install the dependencies with `composer install` and then execute `bin/phpunit`.
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 License
 -------