bmstu-mt-wp/CONTRIBUTING.md

19 lines
1.5 KiB
Markdown
Raw Normal View History

2015-12-13 06:09:18 +03:00
# Contributing to Shower
2015-12-13 06:43:18 +03:00
Youre always welcome to contibute! Before contributing to Shower, please read through unified [issues list](https://github.com/shower/shower/issues) to see open bugs and feature requests. If you have any feature to add to Shower or found a bug and want to fix it, please make sure you [file an issue](https://github.com/shower/shower/issues/new) first.
2015-12-13 06:09:18 +03:00
## Process
2015-12-13 06:43:18 +03:00
Fork needed repository, create a brach for each feature or issue youre dealing with and start making changes. Make sure you code doesnt break tests if there are any. Once youre finished, send pull request back to original repository: one feature or bug fix — one pull request, please dont combine non-relevant changes into one pull request. Supply clear description of your changes and a link to existing issue.
2015-12-13 06:09:18 +03:00
## Code style
2015-12-13 06:43:18 +03:00
Please preserve existing code style while contributing to Shower and be ready for code review by Shower maintainers. Its strongly recommended to install [EditorConfig](http://editorconfig.org) extension to your editor and validate your JavaScript changes using [JSHint](http://jshint.com/).
2015-12-13 06:09:18 +03:00
## Language
2015-12-13 06:43:18 +03:00
English is the main language for Shower project. All discussions and commit messages should be in English, no matter if its good or bad. The second language of Shower is Russian. Official Shower themes are always compatible with Cyrillic and Russian typography. All documentation to Shower is always localized to Russian.
2015-12-13 06:09:18 +03:00
---
2015-12-13 06:43:18 +03:00
Licensed under [MIT License](LICENSE.md).