Skip to content

Commit c4b51ab

Browse files
committed
Add commiting guide
1 parent af82289 commit c4b51ab

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
We love pull requests. Here's a quick guide:
2+
3+
1. Fork the repo. Please also create a separate branch
4+
5+
$ git checkout -b my-cool-feature
6+
7+
We don't accept pull requests from master branches.
8+
9+
2. Make sure the game runs. Follow the README to see how.
10+
11+
5. Push to your fork and submit a pull request.
12+
13+
At this point you're waiting on us. We like to at least comment on, if not
14+
accept, pull requests within a few days. We may suggest some changes or
15+
improvements or alternatives.
16+
17+
Some things that will increase the chance that your pull request is accepted,
18+
taken straight from the Ruby on Rails guide:
19+
20+
* Use Lua idioms and helpers
21+
* Update the documentation, the surrounding one, examples elsewhere, guides,
22+
whatever is affected by your contribution
23+
24+
Syntax:
25+
26+
* Two spaces (or four), no tabs.
27+
* No trailing whitespace. Blank lines should not have any space.
28+
* Follow the conventions you see used in the source already.

0 commit comments

Comments
 (0)