Skip to content

Commit d760bff

Browse files
committed
Added contribution guidelines
1 parent 1e3b3b7 commit d760bff

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to csscss
2+
3+
First of all: thanks!
4+
5+
The main way to contribute to csscss is to write some code! Here's how:
6+
7+
1. Fork csscss
8+
2. Create a topic branch - `git checkout -b my_branch`
9+
3. Push to your branch - `git push origin my_branch`
10+
4. Create a [Pull Request](http://help.github.com/pull-requests/) from your
11+
branch
12+
5. That's it!
13+
14+
If you're not doing some sort of refactoring, a CHANGELOG entry is appropriate.
15+
Please include them in pull requests adding features or fixing bugs.
16+
17+
## Tests
18+
19+
csscss uses minitest for testing.
20+
21+
A simple `bundle exec rake` will run all the tests. Make sure they pass when
22+
you submit a pull request.
23+
24+
Please include tests with your pull request.
25+
26+
## Bugs & Feature Requests
27+
28+
You can file bugs on the [issues
29+
tracker](https://github.com/zmoazeni/csscss/issues), and tag them with 'bug'. Feel free to discuss features there, too.
30+
31+
### Good report structure
32+
33+
Please include the following four things in your report:
34+
35+
1. What you did.
36+
2. What you expected to happen.
37+
3. What happened instead.
38+
39+
The more information the better.

0 commit comments

Comments
 (0)