Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (40 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 2.62 KB

Contributing

We encourage everyone to contribute to this template, your contributions are invaluable in making this repository a great resource for all. We all have the responsibility of improving the standard in our testing frameworks and helping to share best practice.

Setting Up the Project

  1. Clone the Repository:

    git clone https://github.com/hmcts/tcoe-playwright-example

  2. Install Dependencies: Navigate to the repository directory and install required dependencies:

    yarn install

  3. Run Tests: To ensure everything works correctly before making changes, execute the Playwright tests:

    yarn playwright test --project=chrome

  4. Linter: Run the linter to adhere to the style guide/ensure it works:

    yarn lint

Raising a PR

You are free to create a PR with your changes which will be reviewed by Test Leads and the TCoE. There are a few things to be aware of when working in this repo:

Linting

This project uses ESLint (with a playwright plugin), you can run yarn lint to run the linting rules on your changes (the pipeline will also run these checks).

Testing changes

After you've made your changes, ensure that all the tests are stil working correctly by running them.

Your changes should also work in the pipeline: https://build.hmcts.net/job/HMCTS_j_to_z_Nightly/job/tcoe-playwright-example/job/master/ it can be a good idea to ensure any changed tests or dependencies are tested on this pipeline to ensure everything still works. You can use the nightly-dev branch for this.

Documentation

When making changes to this repo, consider whether you need to update documentation. There is a docs directly containing markdown files which describe some concepts used in this repo.

Submit a PR for review

Simply raise a PR to master from your branch, CODEOWNERS will be notified the PR is created. However, you can also link your PR in the slack channels below for visibility. Some things to consider:

  • Ensure your PR accurately describes what it is addressing in the title and description.
  • If you are addressing an active issue, link the issue.
  • Ensure your commits are squashed when merging

Creating an issue

You can also contribute by raising an issue, this can be something you would like to see examples of or things you would like to change/remove/add. There are several tags (enhancement, documentation, bug etc) so please choose the most appropriate.

Support

Reach out in the #testing_centre_of_excellence or #playwright-community channels should you need any help with contributing to this repo.