|
1 | 1 | ## Contributing
|
2 |
| -Changes and improvements are more than welcome! Feel free to fork and open a pull request. Please make your changes in a specifically made branch and request to pull on `master`! If you can, please make sure the game fully works before sending the PR, as that will help speed up the process. |
| 2 | +Changes and improvements are more than welcome! Feel free to fork and open a pull request. |
| 3 | + |
| 4 | +Please follow the house rules to have a bigger chance of your contribution being merged. |
| 5 | + |
| 6 | +### House rules |
| 7 | + |
| 8 | +#### How to make changes |
| 9 | + - To make changes, create a new branch based on `master` (do not create one from `gh-pages` unless strictly necessary) and make them there, then create a Pull Request to master. |
| 10 | + `gh-pages` is different from master in that it contains sharing features, analytics and other things that have no direct bearing with the game. `master` is the "pure" version of the game. |
| 11 | + - If you want to modify the CSS, please edit the SCSS files present in `style/`: `main.scss` and others. Don't edit the `main.css`, because it's supposed to be generated. |
| 12 | + In order to compile your SCSS modifications, you need to use the `sass` gem (install it by running `gem install sass` once Ruby is installed). To run SASS, simply use the following command: |
| 13 | + `sass --watch style/main.scss` |
| 14 | + SASS will automatically recompile your css when changed. |
| 15 | + - `Rakefile` contains some tasks that help during development. Feel free to add useful tasks if needed. |
| 16 | + - Please use 2-space indentation when editing the JavaScript. A `.jshintrc` file is present, which will help your code to follow the guidelines if you install and run `jshint`. |
| 17 | + - Please test your modification thouroughly before submitting your Pull Request. |
| 18 | + |
| 19 | +#### Changes that might not be accepted |
| 20 | +We have to be conservative in regards to the core game. This means that some modifications won't be merged, or will have to be evaluated carefully before doing being merged: |
| 21 | + |
| 22 | + - Undo/redo features |
| 23 | + - Save/reload features |
| 24 | + - Changes to how the tiles look or their contents |
| 25 | + - Changes to the layout |
| 26 | + - Changes to the grid size |
| 27 | + |
| 28 | +#### Changes that are welcome |
| 29 | + - Bug fixes |
| 30 | + - Compatibility improvements |
| 31 | + - "Under the hood" enhancements |
| 32 | + - Small changes that don't have an impact on the core gameplay |
0 commit comments