|
4 | 4 |
|
5 | 5 | Adds a block containing the customer\'s wishlists. |
6 | 6 |
|
7 | | -## Contributing |
8 | | - |
9 | | -PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements. |
10 | | - |
11 | | -### Requirements |
| 7 | +## Reporting issues |
12 | 8 |
|
13 | | -Contributors **must** follow the following rules: |
| 9 | +You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue]. |
14 | 10 |
|
15 | | -* **Make your Pull Request on the "dev" branch**, NOT the "master" branch. |
16 | | -* Do not update the module's version number. |
17 | | -* Follow [the coding standards][1]. |
18 | | - |
19 | | -### Process in details |
| 11 | +## Contributing |
20 | 12 |
|
21 | | -Contributors wishing to edit a module's files should follow the following process: |
| 13 | +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! |
22 | 14 |
|
23 | | -1. Create your GitHub account, if you do not have one already. |
24 | | -2. Fork the blockwishlist project to your GitHub account. |
25 | | -3. Clone your fork to your local machine in the ```/modules``` directory of your PrestaShop installation. |
26 | | -4. Create a branch in your local clone of the module for your changes. |
27 | | -5. Change the files in your branch. Be sure to follow [the coding standards][1]! |
28 | | -6. Push your changed branch to your fork in your GitHub account. |
29 | | -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]. |
30 | | -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. |
| 15 | +Just make sure to follow our [contribution guidelines][contribution-guidelines]. |
31 | 16 |
|
32 | | -That's it: you have contributed to this open-source project! Congratulations! |
| 17 | +## License |
33 | 18 |
|
34 | | -[1]: http://doc.prestashop.com/display/PS16/Coding+Standards |
35 | | -[2]: http://doc.prestashop.com/display/PS16/How+to+write+a+commit+message |
36 | | -[3]: https://help.github.com/articles/using-pull-requests |
| 19 | +This module is released under the [Academic Free License 3.0][AFL-3.0] |
37 | 20 |
|
| 21 | +[report-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose |
| 22 | +[prestashop]: https://www.prestashop.com/ |
| 23 | +[contribution-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/project-modules/ |
| 24 | +[AFL-3.0]: https://opensource.org/licenses/AFL-3.0 |
0 commit comments