This repository has been archived by the owner on Oct 21, 2022. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2773cbd
commit ae4f410
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Contributing to criticalCSS | ||
|
||
Contributions are appreciated. In order for us to consider including a contribution, it does have to meet a few criteria: | ||
|
||
* Code is specific to one issue (eg. feature, extension or bug) | ||
* Code is formatted according to JavaScript Style Guide. | ||
* Code has full test coverage and all tests pass. | ||
|
||
## Code to an Issue | ||
|
||
Use a separate git branch for each contribution. Give the branch a meaningful name. | ||
When you are contributing a new extensions use the name of this extension, like `dom-toggleclass`. | ||
Otherwise give it a descriptive name like `doc-generator` or reference a specific issue like `issues-12`. | ||
When the issue is resolved create a pull request to allow us to review and accept your contribution. | ||
|
||
## JavaScript Style Guide | ||
|
||
Code should be formatted according to the [jQuery JavaScript Style Guide](http://contribute.jquery.org/style-guide/). |