Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Pablo Borowicz committed Dec 31, 2019
1 parent 9a452e8 commit b74cc82
Showing 1 changed file with 22 additions and 39 deletions.
61 changes: 22 additions & 39 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,57 +2,40 @@

## About

Become an e-commerce expert within the blink of an eye!
Become an e-commerce expert within the blink of an eye! This module displays tips in your Back Office to help you make the best out of your shop.

## Reporting issues

All issues are tracked in the main PrestaShop repository: [submit an issue here][submit-issue].

## Contributing

PrestaShop modules are open-source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.

### Requirements
### Execute the test suite

Contributors **must** follow the following rules:
This module is shipped with a test suite using PHPUnit, you need Composer to install the dependencies:

* **Make your Pull Request on the "dev" branch**, NOT the "master" branch.
* Do not update the module's version number.
* Follow [the coding standards][coding-standards].
```
composer install
composer test
```

### Process in details
### Supported PrestaShop versions

Contributors wishing to edit a module's files should follow the following process:
This module is compatible with 1.6.1.x and 1.7.x versions.

1. Create your GitHub account, if you do not have one already.
2. Fork the gamification 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][coding-standards]!
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 contribution guidelines][contrib-guidelines] in your pull request. If you need help to make a pull request, read the [Github help page about creating pull requests][help-pr].
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.
> As of 31th of october, 2018, PrestaShop 1.6.1.x will only receives security patches.
That's it: you have contributed to this open-source project! Congratulations!
This module is maintained for 1.7.4.x and above *only*.

[submit-issue]: https://github.com/PrestaShop/PrestaShop/issues/new/choose
[coding-standards]: https://devdocs.prestashop.com/1.7/development/coding-standards/
[contrib-guidelines]: https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/
[help-pr]: https://help.github.com/articles/using-pull-requests
## Reporting issues

### Execute the testsuite
You can report issues with this module in the main PrestaShop repository. [Click here to report an issue][report-issue].

This module is shipped with a testsuite using PHPUnit, you need Composer to install the dependencies:
## Contributing

```
composer install
composer test
```
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!

### Versions of PrestaShop supported
Just make sure to follow our [contribution guidelines][contribution-guidelines].

This module is compatible with 1.6.1.x and 1.7.x versions.
## License

> As of 31th of october, 2018, PrestaShop 1.6.1.x will only receives security patches.
This module is released under the [Academic Free License 3.0][AFL-3.0]

This module is maintained for 1.7.4.x and above *only*.
[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

0 comments on commit b74cc82

Please sign in to comment.