Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.74 KB

Contributing to Ymple ECommerce

Ymple Ecommerce is an open-source e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.

You can clone the most recent branch ( Not the Master)

Ymple ECommerce is written mostly with Node.js and the framework Sails.

To contribute to the project, you should ideally be familiar with Git, the source code management system that Ymple-Commerce uses, with the official repository being hosted on Github:

Contributors should follow the following process:

  1. Create your Github account, if you do not have one already.
  2. Fork the Ymple-ECommerce project to your Github account.
  3. Clone your fork to your local machine. Be sure to make a recursive clone (use "git clone --recursive git://github.com/username/ymple-ecommerce.git" or check the "Recursive" box in TortoiseGit) in order to have all the Ymple-Commerce modules cloned too!
  4. Create a branch in your local clone for your changes.
  5. Push your changed branch to your fork in your Github account.
  6. Create a pull request for your changes on the Ymple-Commerce 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].
  7. 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!

Thank you for your help in making Ymple-ECommerce even better!

About licenses