Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

49 lines (28 loc) · 2.82 KB
Raw

Contributing

This document details what you can do to contribute to this project.

Code contributions

Code is always welcome. To contribute a patch or a feature, fork the project and when you're done, send a pull request. See the Github docs on how to do it if you're unsure.

If you're adding new .php files to the project please remember to add the copyright header (see other files for example) and adjust the @author comment if necessary. If you're adding modifying an existing .php file and feel like it's an important change then add another @author line in the class documentation.

Development environment

You can use Vagrant to install, provision and configure a development environment. Just run vagrant up from the project root directory.

Project setup

The repository contains NetBeans and PhpStorm projects that you can use.

Styles and scripts handling

The styles for the application are coded in LESS. The LESS files are then combined and compressed into minified stylesheets, which are used by the application. This process is triggered automatically whenever a LESS file is changed as long as the Grunt task runner is running.

Something similar happens for script files. Grunt is used to concatenate and minify all scripts used by the application. Similar to the LESS files this process is automatic and is triggered every time a script file is changed.

To start the Grunt task runner, run grunt in a terminal.

Before you commit any changes, make sure to stop the task runner and run grunt distonce. This ensures all the JavaScript has been compiled and so on.

Debugging

If you use PhpStorm, the debugger should be configured properly out of the box. You may need to change the server address if your Vagrant box does not have the address 10.0.2.15 for some reason.

Translations

Translations are always welcome, and even though it involves a little bit of work (apart from the actual translating) it's not that complicated. Here's what you need to do:

  1. Fork the project on Github and check out a local copy to your computer. A good tool for this is SourceTree.
  2. Open the file src/protected/config/message.php and add the language you want to translate into to the languages array.
  3. In a terminal, run the command src/protected/yiic message src/protected/config/message.php. This will create a new set of files in the src/protected/messages/<language> directory.
  4. Fill in the blanks in all the generated files and create a pull request.

If you need any help, open an issue.

Feature requests and bug reports

Feature requests and bug reports are always welcome, no matter how big or how small. To report something, create an issue on Github.