Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 3.08 KB
Raw

Getting involved

OXID eShop is available under two different licenses, GPLv3 and a commercial license.

That's why, before contributing for the first time, you must sign the Contributor License Agreement. You can find more information about it on the FAQ page OXID Contribution and Contributor Agreement FAQ: http://oxidforge.org/en/oxid-contribution-and-contributor-agreement-faq

Process:
First off, you have to fork the repository OXID-eSales/oxideshop_ce to your list of repositories.

You will find three branches now in youraccount/oxideshop_ce:

  • b-dev-ce, presently our main branch on this repo, is the so called feature branch: All new features will be developed here as well as bug fixes for the next major version.
  • b-5.2-ce is the maintenance branch for the present major version. Only bug fixes here, no new features, no DB changes, no template changes if possible.
  • b-5.1-ce appears as the so called legacy branch: fixes for bugs with higher priority only.

In general, contributions can be taken over for all branches. Bug fixes committed to only one branch will be pushed to the other branches manually. Of course you can also consider to commit e.g. bug fixes to more than one branch.

Best practice:

  • please leave the the branch names as they are
  • if you want to fix a bug or develop a new feature, define an own branch in your repository off of one of the three branches above. Name it e.g. feature/foo or bug/bugname for better tracability
  • change whatever you want and push it back to the original branch (b-dev-ce).

For more information about this, please see:
http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/

Now you'll be asked for signing an OXID Contributor Agreement (this has to be done once). After that we can start checking your code. In every case, whether or not we could take over your contribution, you'll be informed.

Image alt

You will find technical help with Git and GitHub on this place:
https://help.github.com/

Code quality:
Please find a collection of helpful development tools as well as a link to the OXID specific Coding style guidelines at http://oxidforge.org/en/coding-standards.html. We also kindly request to PHP Unit tests for your code.

When sending your pull request, please provide a clear, meaningful and detailed information what your code is about and what it will do, best including a screen shot if possible. If you want to discuss your contribution and your code before committing it, please go to the dev-general mailing list: http://lists.oxidforge.org/mailman/listinfo/dev-general.

Cloning:

To reduce the size of the repository when cloning you can use a so called "shallow clone". With it, the history will be truncated and can save more than 90% of the disk space and traffic in comparison to a full repository clone.

Here is an example of how to use a shallow clone:

git clone --depth 1 https://github.com/OXID-eSales/oxideshop_ce.git