Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.34 KB
Raw

Contributing to the Popover Attribute Polyfill

Ideas, issues, and pull-requests are welcome!

  • Github Issues are the best place to request a feature, file a bug, or just ask a question. Also a great place to discuss possible features before you submit a PR.
  • Pull Requests are a big help, if you're willing to jump in and make things happen. For a bugfix, or documentation, just jump right in. For major changes or new features, it's best to discuss in an issue first.

Conduct

Please follow the OddBird Code of Conduct.

Development

  • Clone the repository.
  • Install dependencies: npm install.
  • Start dev server: npm run serve. Visit localhost:3000.

Code style

JS code is formatted with prettier, and CSS is formatted with stylelint. You can lint the code by running npm run lint and format it with npm run format. We recommend setting up your IDE to automatically format code for you.

Testing

A complete end-to-end test suite is available in the tests/ folder.

  • Configure Playwright (this step is only required once or when the version of @playwright/test changes in package.json): npx playwright install --with-deps
  • Run tests (Chromium only): npm test
  • Run tests (Chromium, Firefox & Webkit): npm run test:ci