Skip to content

Commit 898a4c7

Browse files
committed
Update CONTRIBUTING.md
1 parent 5bf10b1 commit 898a4c7

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Contributing
22

3-
_cssnext uses a lot of [postcss](https://github.com/postcss) plugins,
3+
_postcss-cssnext uses a lot of [postcss](https://github.com/postcss) plugins,
44
so you might need to take a look at them if you find an issue or want to create
55
or enhance a feature._
66

77
Otherwise, fork, work on a branch, install dev-dependencies,
88
respect coding style & run tests before submitting a bug fix or a feature.
99

1010
```console
11-
$ git clone https://github.com/YOU/cssnext.git
11+
$ git clone https://github.com/YOU/postcss-cssnext.git
1212
$ npm install
1313
$ npm test
1414
$ git checkout -b fix.bug423
@@ -31,22 +31,14 @@ module directly in console._
3131
1. Add test files (input + expected output) in [`src/__tests__/fixtures/features`](src/__tests__/features)
3232
- If the feature can affect some others, update [`src/__tests__/fixtures/cases/example.css`](src/__tests__/cases/example.css) to test integration with other features
3333

34-
- Choose a pretty simple and clear name (that match the specs)
35-
- Add the feature in the [README features list](#features) (title, link to spec, link of the plugin, short desc)
36-
- Add the feature in the [README node.js options list](#features-default-all-features) (camelCaseName)
37-
- Add the dependency in the [`package.json`](package.json)
38-
- Add the feature in the source (in [`index.js`](index.js)), in the appropriate place (order matter)
34+
- Choose a pretty simple and clear name (that match the specs), if you are not sure, ask using an issue.
35+
- Add the feature in :
36+
- `docs/content/index.md` (http://cssnext.io/)
37+
- `docs/content/features.md` (http://cssnext.io/features/) with an example + link to specs like others features
38+
- Add the dependency in the [`package.json`](package.json) (use `npm install --save postcss-...`)
39+
- Add the feature in the source (in [`src/features.js`](src/features.js)), in the appropriate place (order matter)
3940
For now, use a empty function instead of the right module
4041
- Run test, & check tests are broken (otherwise feature is useless)
41-
Now, call the right plugin
42+
Now, call the right plugin in the function you just created
4243
- Run test and be happy
43-
- Add feature in [the docs](docs/content)
4444
- Add feature on [the playground](docs/content/playground.html) example
45-
46-
47-
### Edit messages styles
48-
49-
- default styles are in src/option.messages.browser.styles.js
50-
- test render by running: `babel-node src/__tests__/messages`.
51-
Styles will be compiled, rendered in a web page & the webpage will be opened for
52-
you.

0 commit comments

Comments
 (0)