33If you want to contribute to PostCSS, there are a few things that you should
44be familiar with.
55
6-
76## Adding Your Plugin to the List
87
98If you created or found a plugin and want to add it to the PostCSS plugins list
@@ -14,55 +13,53 @@ moderated by the PostCSS author.
1413
1514Plugins submitted by the community are located in [ ` docs/plugins ` ] .
1615
17- * ** Keep plugins ordered**
16+ - ** Keep plugins ordered**
1817
19- Be sure that a plugin is not already present and find a suitable position
20- for it in alphabetical order.
21- However plugins with ` postcss- ` prefix should come first.
18+ Be sure that a plugin is not already present and find a suitable position
19+ for it in alphabetical order.
20+ However plugins with ` postcss- ` prefix should come first.
2221
23- * ** Check spelling**
22+ - ** Check spelling**
2423
25- Before submitting a PR make sure the spelling check is passing.
26- To run the check use ` npm test ` .
27- If it fails with an unknown word error, add it as a word
28- to ` .yaspellerrc ` dictionary.
24+ Before submitting a PR make sure the spelling check is passing.
25+ To run the check use ` npm test ` .
26+ If it fails with an unknown word error, add it as a word
27+ to ` .yaspellerrc ` dictionary.
2928
30- * ** Check PostCSS plugin guidelines**
29+ - ** Check PostCSS plugin guidelines**
3130
32- The suggested plugin should match plugin [ guidelines] .
31+ The suggested plugin should match plugin [ guidelines] .
3332
34- - ** Provide link to suggested plugin**
33+ * ** Provide link to suggested plugin**
3534
36- Make sure your pull request description contains a link to the plugin
37- you want to add.
35+ Make sure your pull request description contains a link to the plugin
36+ you want to add.
3837
3938[ `docs/plugins` ] : https://github.com/postcss/postcss/blob/main/docs/plugins.md
40- [ guidelines ] : https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md
41-
39+ [ guidelines ] : https://github.com/postcss/postcss/blob/main/docs/guidelines/plugin.md
4240
4341## TypeScript Declaration Improvements
4442
4543If you found a bug or want to add certain improvements to types declaration file:
4644
47- * ** Check current TypeScript styling**
45+ - ** Check current TypeScript styling**
4846
49- Be sure that your changes match TypeScript styling rules defined in typings file.
50- * We use classes for existing JS classes like ` Stringifier ` .
51- * Namespaces used for separating functions related to the same subject.
52- * Interfaces used for defining custom types.
47+ Be sure that your changes match TypeScript styling rules defined in typings file.
48+ - We use classes for existing JS classes like ` Stringifier ` .
49+ - Namespaces used for separating functions related to the same subject.
50+ - Interfaces used for defining custom types.
5351
54- Make sure you read through declaration file writing [ best practices]
55- by the TypeScript team.
52+ Make sure you read through declaration file writing [ best practices]
53+ by the TypeScript team.
5654
5755[ best practices ] : https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html
5856
59-
6057## Core Development
6158
6259If you want to add new features or fix existing issues
6360
6461- ** Become familiar with PostCSS architecture**
6562
66- For a gentle intro to PostCSS architecture look through our [ guide] .
63+ For a gentle intro to PostCSS architecture look through our [ guide] .
6764
6865[ guide ] : https://github.com/postcss/postcss/blob/main/docs/architecture.md
0 commit comments