项目原始demo,不改动
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

CONTRIBUTING.md 2.3 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. # Contributing Guide to PostCSS
  2. If you want contribute to PostCSS, there are few things that you should
  3. be familiar with.
  4. ## In Case You Have Question About Using PostCSS
  5. * **Ask for help in [the chat]**
  6. If you stuck on something there is a big chance
  7. that someone had similar problem before.
  8. [the chat]: https://gitter.im/postcss/postcss
  9. ## Adding Your Plugin to the List
  10. If you created or found a plugin and want to add it to PostCSS plugins list
  11. follow this simple steps.
  12. PR should not change plugins defined in README it contains only favorite plugins
  13. and moderated by PostCSS author.
  14. Plugins submitted by community located in [`docs/plugins`].
  15. * **Keep plugins order**
  16. Be sure that plugin not presented yet and find suitable position
  17. in alphabetic order for it.
  18. But plugins with `postcss-` prefix should come first.
  19. * **Check spelling**
  20. Before submitting PR be sure that spelling check pass.
  21. For that run command `npm test`.
  22. If it fails with unknown word error, add it as word
  23. to `.yaspellerrc` dictionary.
  24. * **Check PostCSS plugin guideline**
  25. Provided plugin should match plugin [guidelines].
  26. - **Provide link to suggested plugin**
  27. Make sure your pull request description contains link to plugin
  28. you are willing to add.
  29. [`docs/plugins`]: https://github.com/postcss/postcss/blob/master/docs/plugins.md
  30. [guidelines]: https://github.com/postcss/postcss/blob/master/docs/guidelines/plugin.md
  31. ## TypeScript Declaration Improvements
  32. If you found a bug or want to add certain improvements to types declaration file
  33. * **Check current TypeScript styling**
  34. Be sure that your changes match TypeScript styling rules defined in typings file.
  35. * We use classes for existing JS classes like `Stringifier`.
  36. * Namespaces used for separating functions related to same subject.
  37. * Interfaces used for defining custom types.
  38. Make sure you read through declaration file writing [best practices]
  39. by TypeScript team.
  40. [best practices]: https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html
  41. ## Core Development
  42. If you want to add new feature or fix existed issue
  43. - **Become familiar with PostCSS architecture**
  44. For gentle intro to PostCSS architecture look through our [guide].
  45. [guide]: https://github.com/postcss/postcss/blob/master/docs/architecture.md