Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.71 KB

Readme.md

File metadata and controls

37 lines (24 loc) · 1.71 KB
Raw

Customer referral program

About

Integrate a referral program system into your shop.

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

Contributors must follow the following rules:

  • Make your Pull Request on the "dev" branch, NOT the "master" branch.
  • Do not update the module's version number.
  • Follow the coding standards.

Process in details

Contributors wishing to edit a module's files should follow the following process:

  1. Create your GitHub account, if you do not have one already.
  2. Fork the referralprogram 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!
  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 in your pull request. If you need help to make a pull request, read the Github help page about creating pull requests.
  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.

That's it: you have contributed to this open-source project! Congratulations!