Skip to content

Commit

Permalink
adding README and images used in it
Browse files Browse the repository at this point in the history
  • Loading branch information
kermie committed May 13, 2013
1 parent ef8e256 commit 9fc9acb
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
OXID eShop
==========

This repository contains the sources of OXID eShop Community Edition.

###About OXID eShop:

OXID eShop is a flexible open source e-commerce software with a wide range of functionalities.
Thanks to its modular, modern and state-of-the-art architecture, it can be modified, expanded
and customized to individual requirements with the greatest of ease.

OXID eShop is just e-commerce software for agencies with deadlines :-)

![Image alt](https://raw.github.com/OXID-eSales/oxideshop_ce/master/frontend.png)


###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 send the filled form "OXID eSales Contributor Agreement"
(http://wiki.oxidforge.org/File:Oxid_esales_ca_v151.pdf) to [email protected]. You can find more
information about it on the FAQ page OXID Contribution and Contributor Agreement FAQ
http://wiki.oxidforge.org/OXID_Contribution_and_Contributor_Agreement_FAQ

Process:
First off, you have to fork the repository OXID-eSales/oxideshop_ce to your list of repositories. Change whatever you want and push it back to the original repository. 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 your over your contribution, you'll be informed.

![Image alt](https://raw.github.com/OXID-eSales/oxideshop_ce/master/git_contributor-activity.png)

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

Code quality:
We are still working on providing OXID specific code guidlines and tutorials to you. Until this, we propose to refer to
http://framework.zend.com/manual/1.12/en/coding-standard.coding-style.html
Also, please provide PHP unit tests for your code.

When sending your pull request, please provide a clear, meaningful and detailed information about 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.

Useful links:
Project home page - http://www.oxid-esales.com
Wiki - http://www.oxidforge.org
Binary file added frontend.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added git_contributor-activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9fc9acb

Please sign in to comment.