Skip to content

Commit 03d58c9

Browse files
authored
Merge pull request postcss#63 from postcss/contributing-md
Add CONTRIBUTING.md
2 parents acecba2 + 197c903 commit 03d58c9

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Contributing
2+
3+
The following outlines a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.
4+
5+
## Asking questions
6+
7+
Prefer asking questions in the [PostCSS chat](https://gitter.im/postcss/postcss) over opening issues.
8+
Leveraging the community would likely get you an answer faster, as well as leave us available to solve issues and make the product better.
9+
10+
## Reporting Bugs
11+
12+
Before submitting a new issue, be sure to make a cursory search to see if the problem has already been reported. If it has and the issue is still open, leave a comment on the existing issue instead of opening a new one.
13+
14+
If no prior issue exist, create a new one. Explain the problem and include additional details to help maintainers reproduce the problem:
15+
16+
* Use a clear and descriptive title.
17+
* Summarize the problem you are having.
18+
* Include details about your configuration and environment.
19+
* Provide steps to reproduce the problem.
20+
* Describe what behavior you expected to see.
21+
22+
## Requesting Enhancements
23+
24+
Before submitting a new issue, be sure to make a cursory search to see if the enhancement has already been requested. If no such issue exists, create a new one and detail it to the best of your ability:
25+
26+
* Use a clear and descriptive title.
27+
* Provide a description of the proposed enhancement.
28+
* Exemplify what needs/uses this enhancement would address.
29+
30+
## Submitting Pull Requests
31+
32+
Before contributing any code to the project, be sure to either open a new issue in the issue tracker detailing what you intend to contribute, or comment on an existing issue if one exists.
33+
This allows us to:
34+
35+
* give feedback early on before significant effort has been put into the endevour.
36+
* align your contribution with ongoing efforts.
37+
* make sure that there's no ongoing effort into the issue already.
38+
39+
When submitting your pull request, make sure that you:
40+
41+
* use a clear and descriptive title.
42+
* summarize your contribution.
43+
* list the issues that this contribution addresses.
44+
* include tests for your contribution.

0 commit comments

Comments
 (0)