Skip to content

Commit beb449e

Browse files
committed
Expanding Paul's original contributing doc
1 parent e675858 commit beb449e

File tree

3 files changed

+43
-27
lines changed

3 files changed

+43
-27
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
* Fixes parsing bug with quoted brackets #72
66
* Fixes parsing bug with nested media queries #73
77
* Removes --compass-with-config deprecation
8+
* Adds a CONTRIBUTING.md file with instructions
89

910
## 1.3.1 - 4/20/2013 ##
1011

CONTRIBUTING.md

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,53 @@
11
# Contributing to csscss
22

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.
3+
First of all: Thanks!
254

265
## Bugs & Feature Requests
276

287
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.
8+
tracker](https://github.com/zmoazeni/csscss/issues), and tag them with
9+
'bug'. Feel free to discuss features there, too.
3010

31-
### Good report structure
11+
## Good report structure
3212

3313
Please include the following four things in your report:
3414

35-
1. What you did.
36-
2. What you expected to happen.
37-
3. What happened instead.
15+
1. The smallest CSS snippet to explain the problem.
16+
2. What you did.
17+
3. What you expected to happen.
18+
4. What happened instead.
3819

3920
The more information the better.
21+
22+
## Contributing Code
23+
24+
It's easy to contribute code to csscss:
25+
26+
1. Fork csscss.
27+
2. Create a topic branch - `git checkout -b my_branch`
28+
3. Push to your branch - `git push origin my_branch`
29+
4. Make sure the code follows the contributing guidelines below.
30+
5. Create a [Pull Request](http://help.github.com/pull-requests/) from your
31+
branch.
32+
6. That's it!
33+
34+
## First Time OSS Contributors
35+
36+
Submitting your first pull request can be a little daunting. If this is
37+
your first Open Source contribution, please mention it in your pull
38+
request and I'll help guide you through the process.
39+
40+
## Contributing Guidelines
41+
42+
* Make sure your code follows typical [ruby
43+
conventions](https://github.com/bbatsov/ruby-style-guide).
44+
* Make sure the test suite is green. A simple `bundle exec rake test`
45+
will run all the tests.
46+
* Include a CHANGELOG entry with your change. Add an `(Unreleased)`
47+
section at the top if one doesn't exist.
48+
* Try to keep the git commits squashed and concise. Keep tests and code
49+
changes together in the same commit. Keep only logical changes together
50+
in a single commit.
51+
* I strongly encourage [well written git commit
52+
messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
53+
* Make sure all whitespace is trimmed from the end of lines.

CONTRIBUTORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@
55
* Matt DuVall @mduvall twitter:@mduvall_
66
* Mekka Okereke @mekka @mekkaokereke
77
* JoseLuis Torres @joseluistorres twitter:@joseluis_torres
8+
* Paul Simpson @prsimp

0 commit comments

Comments
 (0)