mirror of
https://github.com/wintercms/winter.git
synced 2024-06-28 05:33:29 +02:00
25 lines
1.3 KiB
Markdown
25 lines
1.3 KiB
Markdown
# Contributing to OctoberCMS
|
|
|
|
Your contributions to the project are very welcome. If you would like to fix a bug or propose a new feature, you can submit a Pull Request.
|
|
|
|
To help us merge your Pull Request, please make sure you follow these points:
|
|
|
|
1. Describe the problem clearly in the Pull Request description
|
|
1. Please make your fix on the `develop` branch. This makes merging much easier.
|
|
1. Do not edit compiled asset files such as `october.css` Instead, try to edit the LESS files inside the `less/` directory and then use a compiler.
|
|
1. For any change that you make, **please try to also add a test case(s)** in the `tests/unit` directory. This helps us understand the issue and make sure that it will stay fixed forever.
|
|
|
|
Thank you for your contributions!
|
|
|
|
## PSR Coding standards
|
|
|
|
Also ensure that your Pull Request satisfies the following coding standards:
|
|
|
|
- [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
|
|
- [PSR 1 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
|
|
- [PSR 0 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)
|
|
|
|
## Team rules
|
|
|
|
The October team follows the [developer guidelines](https://github.com/octobercms/docs/blob/master/help-developer-guide.md) as much as possible.
|