Skip to content

Latest commit

History

History
49 lines (31 loc) 路 2.6 KB

contribute.md

File metadata and controls

49 lines (31 loc) 路 2.6 KB
id title
contribute
馃檵 Contribute

QA Wolf is an open source project, and we welcome improvements from the community!

馃挕If you have an idea for a new feature or enhancement, please chat with us or open an issue with your proposal!

馃憖 If you are looking for something to work on, please see our open issues and comment on any that you'd like to tackle.

Improve the docs

Improving our documentation is a great way to start contributing to QA Wolf. Our docs are also open source and are built with the awesome Docusaurus library.

To get started, first fork the qawolf repository. See GitHub documentation to learn how to fork a repository.

Change directories into the docs folder:

cd qawolf/docs

Start the development server:

# inside qawolf/docs
npm run start

You will be able to view the docs at localhost:3000 (or a different port if 3000 is busy).

Each page in the docs lives in a named Markdown file in the qawolf/docs/docs folder. For example, the file with the Markdown for this page is qawolf/docs/docs/contribute.md.

If you update the Markdown file and save it, your changes will be visible on localhost:3000.

Once you've made your changes, make a pull request to the qawolf repository. See GitHub documentation to learn more about creating a pull request.

If you have any questions please chat with us on Gitter!

What are all of these packages?!

We maintain several packages under the qawolf organzation. Feel free to contribute to any of them!

  • qawolf is a Node.js library for creating Playwright/Jest tests and scripts
  • playwright-ci provides a CLI to set up tests in CI
  • playwright-html-selector is a custom selector engine for Playwright that finds elements by their HTML
  • playwright-utils contains utility functions to help with Playwright (for example, save debug artifacts and scroll)
  • playwright-video saves a video of a Playwright page