Skip to content

Commit 52779a9

Browse files
authored
link to guidelines from contributing (#529)
1 parent 573268e commit 52779a9

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

CONTRIBUTING.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,20 @@ instructions:
2323

2424
- [Node.js](https://nodejs.org/) >= 16.0.0
2525

26+
### Quick start
27+
28+
1. fork the repo and clone it locally
29+
2. `npm run get-me-going` to install and build dependencies
30+
3. `cd plugins/<plugin-name>`
31+
4. `npm run build && npm run test` to build and test the plugin after making changes
32+
5. open a pull request with the changes
33+
2634
## Submitting Pull Requests
2735

28-
Pull requests are the greatest contributions, so be sure they are focused in
29-
scope and avoid unrelated commits.
36+
We try our best to create a safe and welcoming environment for contributors.
37+
38+
Your changes do not have to be complete and tests do not have to pass before opening a pull request.
39+
Receiving early feedback on your work will help you iterate more quickly in the right direction.
3040

3141
1. To begin; [fork this project], clone your fork, and add our upstream.
3242
```bash
@@ -133,6 +143,12 @@ Your next steps:
133143
Change "blue" to "purple" in "src/index.ts" and see how it affects the test outcome
134144
```
135145

146+
## Read the guidelines and best practices for plugins
147+
148+
- [PostCSS API documentation](https://postcss.org/api/)
149+
- [PostCSS guidelines for plugins](https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md)
150+
- [CSSTools guidelines for plugins](https://github.com/csstools/postcss-plugins/wiki/Plugin-best-practices)
151+
136152
## Trouble shooting
137153

138154
This is a mono repo that contains unpublished packages.

0 commit comments

Comments
 (0)