Skip to content

Commit 71baa9d

Browse files
Update CONTRIBUTING.md
1 parent 7dcbe28 commit 71baa9d

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,32 @@
1-
## Contributing
1+
# Contributing
22
Changes and improvements are more than welcome! Feel free to fork and open a pull request.
33

44
Please follow the house rules to have a bigger chance of your contribution being merged.
55

6-
### House rules
6+
## House rules
77

8-
#### How to make changes
8+
### How to make changes
99
- 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.
1010
`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.
1111
- 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:
1314
`sass --watch style/main.scss`
1415
SASS will automatically recompile your css when changed.
1516
- `Rakefile` contains some tasks that help during development. Feel free to add useful tasks if needed.
1617
- 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`.
1718
- Please test your modification thouroughly before submitting your Pull Request.
1819

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:
2122

2223
- Undo/redo features
2324
- Save/reload features
2425
- Changes to how the tiles look or their contents
2526
- Changes to the layout
2627
- Changes to the grid size
2728

28-
#### Changes that are welcome
29+
### Changes that are welcome
2930
- Bug fixes
3031
- Compatibility improvements
3132
- "Under the hood" enhancements

0 commit comments

Comments
 (0)