-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* build: Use node 22 * revisit docs * use python 3.12 * update README * bump cucumber reporter version * json report file config now needs quotes * do not use npm cache for cucumber test * test cucumber test * restore test * downgrade to @cucumber/cucumber@v9 * add cached npm config back
- Loading branch information
1 parent
a9f44fa
commit 1416420
Showing
19 changed files
with
3,030 additions
and
2,227 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,58 +1,56 @@ | ||
| # Contributing to `sauce-playwright-runner` | ||
|
|
||
| **Thank you for your interest in `sauce-playwright-runner`. Your contributions are highly welcome.** | ||
| **Thank you for your interest in `sauce-playwright-runner`. Your contributions are highly valued.** | ||
|
|
||
| There are multiple ways of getting involved: | ||
| ## Ways to Get Involved | ||
|
|
||
| - [Report a bug](#report-a-bug) | ||
| - [Suggest a feature](#suggest-a-feature) | ||
| - [Contribute code](#contribute-code) | ||
| - **[Report a Bug](#report-a-bug)**: Help improve the project by reporting bugs. | ||
| - **[Suggest a Feature](#suggest-a-feature)**: Propose new ideas and enhancements. | ||
| - **[Contribute Code](#contribute-code)**: Develop and contribute your code. | ||
|
|
||
| Below are a few guidelines we would like you to follow. | ||
| If you need help, please reach out to us by opening an issue. | ||
| Please follow the guidelines below to contribute effectively. If you need assistance, feel free to open an issue. | ||
|
|
||
| ## Report a bug | ||
| Reporting bugs is one of the best ways to contribute. Before creating a bug report, please check that an [issue](/issues) reporting the same problem does not already exist. If there is such an issue, you may add your information as a comment. | ||
| ## Report a Bug | ||
|
|
||
| To report a new bug you should open an issue that summarizes the bug and set the label to "bug". | ||
| Before reporting a bug, please ensure there is no existing issue addressing the same problem. If an issue exists, contribute by adding your information in a comment. | ||
|
|
||
| If you want to provide a fix along with your bug report: That is great! In this case please send us a pull request as described in section [Contribute Code](#contribute-code). | ||
| To report a new bug: | ||
| - Open an issue summarizing the bug. | ||
| - Label it as "bug". | ||
| - If you are also submitting a fix, please follow the instructions under [Contribute Code](#contribute-code). | ||
|
|
||
| ## Suggest a feature | ||
| To request a new feature you should open an [issue](../../issues/new) and summarize the desired functionality and its use case. Set the issue label to "feature". | ||
| ## Suggest a Feature | ||
|
|
||
| ## Contribute code | ||
| This is an outline of what the workflow for code contributions looks like | ||
| For feature requests: | ||
| - Open a [new issue](../../issues/new). | ||
| - Clearly summarize the desired functionality and its use case. | ||
| - Label the issue as "feature". | ||
|
|
||
| - Check the list of open [issues](../../issues). Either assign an existing issue to yourself, or | ||
| create a new one that you would like work on and discuss your ideas and use cases. | ||
| ## Contribute Code | ||
|
|
||
| It is always best to discuss your plans beforehand, to ensure that your contribution is in line with our goals. | ||
| ### Workflow | ||
|
|
||
| - Fork the repository on GitHub | ||
| - Create a topic branch from where you want to base your work. This is usually 'main'. | ||
| - Open a new pull request, label it `work in progress` and outline what you will be contributing | ||
| - Make commits of logical units. | ||
| - Make sure you sign-off on your commits `git commit -s -m "adding X to change Y"` | ||
| - Write good commit messages (see below). | ||
| - Push your changes to a topic branch in your fork of the repository. | ||
| - As you push your changes, update the pull request with new infomation and tasks as you complete them | ||
| - Project maintainers might comment on your work as you progress | ||
| - When you are done, remove the `work in progess` label and ping the maintainers for a review | ||
| - Your pull request must receive a :thumbsup: from two [maintainers](MAINTAINERS) | ||
| 1. Explore open [issues](../../issues). You can take up an existing issue or create a new one to discuss your ideas. | ||
| 2. Fork the repository on GitHub. | ||
| 3. Create a topic branch from `main`. | ||
| 4. Start a pull request and label it as `work in progress`. Describe your contributions. | ||
| 5. Commit your changes: | ||
| - Use logical commit units. | ||
| - Include clear commit messages. | ||
| - Sign off your commits with `git commit -s -m "describe your change"`. | ||
| 6. Push your changes to your fork and update your pull request as you make progress. | ||
| 7. Engage with any feedback from maintainers. | ||
| 8. When complete, remove the `work in progress` label and notify maintainers for review. | ||
| 9. Your pull request needs approval from two [maintainers](MAINTAINERS). | ||
|
|
||
| Thanks for your contributions! | ||
| ### Commit Messages | ||
|
|
||
| ### Commit messages | ||
| Your commit messages ideally can answer two questions: what changed and why. The subject line should feature the “what” and the body of the commit should describe the “why”. | ||
| Your commit messages should answer two questions: what changed and why? The subject should state what was changed, and the body should explain why. | ||
|
|
||
| When creating a pull request, its description should reference the corresponding issue id. | ||
| Reference the corresponding issue ID in your pull request description. | ||
|
|
||
| ### Sign your work / Developer certificate of origin | ||
| All contributions (including pull requests) must agree to the Developer Certificate of Origin (DCO) version 1.1. This is exactly the same one created and used by the Linux kernel developers and posted on http://developercertificate.org/. This is a developer's certification that he or she has the right to submit the patch for inclusion into the project. Simply submitting a contribution implies this agreement, however, please include a "Signed-off-by" tag in every patch (this tag is a conventional way to confirm that you agree to the DCO) - you can automate this with a [Git hook](https://stackoverflow.com/questions/15015894/git-add-signed-off-by-line-using-format-signoff-not-working) | ||
|
|
||
| ``` | ||
| git commit -s -m "adding X to change Y" | ||
| ```bash | ||
| git commit -s -m "your detailed description of the change" | ||
| ``` | ||
|
|
||
| **Have fun, and happy hacking!** | ||
| **Enjoy contributing, and happy coding!** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| Sauce Playwright Runner | ||
| ======================= | ||
| # Sauce Playwright Runner | ||
|
|
||
| Sauce Labs test runner image for [`saucectl`](https://github.com/saucelabs/saucectl) to run [Playwright](https://playwright.dev/) tests using [saucectl](https://docs.saucelabs.com/dev/cli/saucectl/). This repository contains the code that is being executed in Sauce Labs when running `saucectl run`. | ||
| This is the Sauce Labs test runner for [`saucectl`](https://github.com/saucelabs/saucectl), designed to run [Playwright](https://playwright.dev/) tests. The code in this repository is executed within Sauce Labs during a `saucectl run`. | ||
|
|
||
| If you are interested to contribute to this project, please have a look into our [contribution guidelines](https://github.com/saucelabs/sauce-playwright-runner/blob/main/CONTRIBUTING.md). | ||
| If you are interested in contributing to this project, please review our [contribution guidelines](https://github.com/saucelabs/sauce-playwright-runner/blob/main/CONTRIBUTING.md). |
Oops, something went wrong.