31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# Contributing
|
|
|
|
### Understanding
|
|
|
|
Before getting started, you should read our article introducing the project:
|
|
[We're Building A Starter Theme For PrestaShop 1.7.0.0](http://build.prestashop.com/news/starter-theme-kickoff/).
|
|
|
|
If you are contributing to this theme, you are probably interested in PrestaShop development as well. Please the following article to get familiar with [PrestaShop branching model](http://build.prestashop.com/news/introducing-new-branching-model-prestashop/).
|
|
|
|
You got any questions ? Join the gitter chat room.
|
|
|
|
[](https://gitter.im/PrestaShop/StarterTheme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
|
|
### Setting up
|
|
|
|
There are few things to do before you are ready to contribute.
|
|
|
|
1. Check your _Git_ configuration. Read [Set Up Your Git For Contributing](http://build.prestashop.com/howtos/misc/set-up-your-git-for-contributing/)
|
|
1. Check your editor configuration. The rules are defined in `.editorconfig`. Do it manually or [install the available plugin](http://editorconfig.org/#download).
|
|
|
|
|
|
### Reporting issues
|
|
|
|
The _Starter Theme_ project is the only PrestaShop project that **use GitHub issues**. Please don't report any bug on the forge but open an issue here.
|
|
|
|
Open an issue:
|
|
|
|
1. To report a bug.
|
|
1. To propose an improvement and get feedbacks before you code it. ([example](https://github.com/PrestaShop/StarterTheme/issues/2))
|