Skip to content

Commit def2714

Browse files
author
cferdinandi
committed
Added contributing.md
1 parent d049eda commit def2714

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+
# How to contribute
2+
3+
I'm delighted that you're helping make this open source project better. Here are a few quick guidelines to make this an easier and better process for everyone.
4+
5+
6+
7+
## Reporting a bug
8+
9+
First, **make sure the bug hasn't already been reported** by searching GitHub's issues section.
10+
11+
If no existing issue exists, go ahead and create one. **Please be sure to include all of the following:**
12+
13+
1. A clear, descriptive title (ie. "A bug" is *not* a good title).
14+
2. [A reduced test case.](https://css-tricks.com/reduced-test-cases/) In order to debug code issues, I need to see actual code in a browser.
15+
3. The browser and OS that you're using.
16+
17+
18+
19+
## Asking a question
20+
21+
Before asking, please **make sure the question hasn't already been asked** by searching GitHub's issues section.
22+
23+
24+
25+
## Submitting a Pull Request
26+
27+
Please make sure your code meets the following code standards:
28+
29+
- Camel case for JavaScript variables.
30+
- [Object-Oriented CSS](http://www.slideshare.net/stubbornella/object-oriented-css) for CSS selectors.
31+
- Favor readable code over brevity. The build process will reduce size, so opt for readability. (ex. `var navigation` is better than `var n`)
32+
- Order CSS properties alphabetically.
33+
- Hard tabs.
34+
35+
Before submitting, make sure that you've:
36+
37+
- Updated the version number using semantic versioning.
38+
- Made your changes in the `src` folder.
39+
- Run the Gulp build to compile, minify, and update version numbers into the `dist` folder. If you cannot do this, please note this in the Pull Request.

0 commit comments

Comments
 (0)