Merge pull request #372 from matks/improve-readme

Improve README

Readme.md

@@ -66,43 +66,26 @@ The following parameters are mandatory:
 $ php cli-rollback.php  --dir=admin-dev --backup=V1.7.5.1_20190502-191341-22e883bd
 ```
 
-## Contributing
+# Documentation
 
-PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.
+Documentation is hosted on [devdocs.prestashop.com][doc].
 
-To contribute on this project, start by cloning the repository.
-You must have [composer][4] installed on your computer. Run the following command:
+# Contributing
 
-```
-$ composer install
-```
-
-Your module will be available with development libraries.
-
-### GitHub Requirements
-
-Contributors **must** follow the following rules:
+PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!
 
-* **Make your Pull Request on the "dev" branch**, NOT the "master" branch.
-* Do not update the module's version number.
-* Follow [the coding standards][1].
+Just make sure to follow our [contribution guidelines][contribution-guidelines].
 
-### Process in details
+## Reporting issues
 
-Contributors wishing to edit a module's files should follow the following process:
+You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue].
 
-1. Create your GitHub account, if you do not have one already.
-2. Fork the autoupgrade project to your GitHub account.
-3. Clone your fork to your local machine in the ```/modules``` directory of your PrestaShop installation.
-4. Create a branch in your local clone of the module for your changes.
-5. Change the files in your branch. Be sure to follow [the coding standards][1]!
-6. Push your changed branch to your fork in your GitHub account.
-7. Create a pull request for your changes **on the _'dev'_ branch** of the module's project. Be sure to follow [the commit message norm][2] in your pull request. If you need help to make a pull request, read the [Github help page about creating pull requests][3].
-8. Wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code.
+# License
 
-That's it: you have contributed to this open-source project! Congratulations!
+This module is released under the [Academic Free License 3.0][AFL-3.0]
 
-[1]: http://doc.prestashop.com/display/PS16/Coding+Standards
-[2]: http://doc.prestashop.com/display/PS16/How+to+write+a+commit+message
-[3]: https://help.github.com/articles/using-pull-requests
-[4]: https://getcomposer.org/download/
+[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
+[prestashop]: https://www.prestashop.com/
+[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/
+[AFL-3.0]: https://opensource.org/licenses/AFL-3.0
+[doc]: https://devdocs.prestashop.com/1.7/development/upgrade-module/