Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 2.14 KB

PostCSS Prefix Wrap // Contributing

Outlines how to contribute to the development of PostCSS Prefix Wrap.

Core Maintainers

Thanks

Thanks to all of the Contributors who maintain PostCSS Prefix Wrap and Jeff Teng for contributing to the initial design.

Continuous Integration

Provided by GitHub Actions, run on every commit and pull request.

Code Formatting

Code formatting support provided by Prettier.

make format

Alternatively, you can check if the code is already formatted correctly by executing the lint job instead.

make lint

Test

Tested using Jest, using test cases defined in the src/ directory matching *.spec.ts pattern.

make test

Our test suite contains the following kinds of tests:

  • Unit - Does each unit of code perform its intended purpose, and do we handle potential error cases correctly.
  • Integration - Can our plugin be loaded into PostCSS and then executed correctly.
  • Acceptance - Does our plugin perform the correct operations based on provided configuration.

Publishing

⚠️ Publishing new releases can only be completed by the Core Maintainers.

  1. Update CHANGELOG.md and package.json with details on the updated release version.
  2. Commit these changes, and merge them into main via a pull request.
  3. Then Publish a new release to trigger publishing a new version of this package.
  4. GitHub will then trigger the release pipeline to publish the release to NPM.
  5. Core Maintainers will receive a notification from NPM when the package has been published.