|
1 |
| -## Contributing |
| 1 | +# Contributing |
2 | 2 | Changes and improvements are more than welcome! Feel free to fork and open a pull request.
|
3 | 3 |
|
4 | 4 | Please follow the house rules to have a bigger chance of your contribution being merged.
|
5 | 5 |
|
6 |
| -### House rules |
| 6 | +## House rules |
7 | 7 |
|
8 |
| -#### How to make changes |
| 8 | +### How to make changes |
9 | 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 | 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 | 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: |
| 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). |
| 13 | + To run SASS, simply use the following command: |
13 | 14 | `sass --watch style/main.scss`
|
14 | 15 | SASS will automatically recompile your css when changed.
|
15 | 16 | - `Rakefile` contains some tasks that help during development. Feel free to add useful tasks if needed.
|
16 | 17 | - 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 | 18 | - Please test your modification thouroughly before submitting your Pull Request.
|
18 | 19 |
|
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: |
| 20 | +### Changes that might not be accepted |
| 21 | +We have to be conservative with the core game. This means that some modifications won't be merged, or will have to be evaluated carefully before being merged: |
21 | 22 |
|
22 | 23 | - Undo/redo features
|
23 | 24 | - Save/reload features
|
24 | 25 | - Changes to how the tiles look or their contents
|
25 | 26 | - Changes to the layout
|
26 | 27 | - Changes to the grid size
|
27 | 28 |
|
28 |
| -#### Changes that are welcome |
| 29 | +### Changes that are welcome |
29 | 30 | - Bug fixes
|
30 | 31 | - Compatibility improvements
|
31 | 32 | - "Under the hood" enhancements
|
|
0 commit comments