Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.16 KB

Contributing to sauce-playwright-runner

Thank you for your interest in sauce-playwright-runner. Your contributions are highly valued.

Ways to Get Involved

Please follow the guidelines below to contribute effectively. If you need assistance, feel free to open an issue.

Report a 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.

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.

Suggest a Feature

For feature requests:

  • Open a new issue.
  • Clearly summarize the desired functionality and its use case.
  • Label the issue as "feature".

Contribute Code

Workflow

  1. Explore open 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.

Commit Messages

Your commit messages should answer two questions: what changed and why? The subject should state what was changed, and the body should explain why.

Reference the corresponding issue ID in your pull request description.

git commit -s -m "your detailed description of the change"

Enjoy contributing, and happy coding!