Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.93 KB
Raw

Contributing to sauce-testcafe-runner

Thank you for your interest in sauce-testcafe-runner. We highly appreciate and welcome your contributions.

Ways to Get Involved

For any assistance, please don't hesitate to reach out by opening an issue.

Report a Bug

Before reporting a bug, please check if there is an existing issue addressing the same concern. If such an issue exists, feel free to contribute by adding your comments.

To report a new bug:

  • Open an issue summarizing the bug details.
  • Label it as "bug."
  • If you have a solution or a fix, wonderful! Please submit a pull request as outlined in the Contribute Code section.

Suggest a Feature

To suggest a new feature:

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

Contribute Code

Code Contribution Workflow

  1. Explore Open Issues: Browse through the open issues. You can either work on an existing issue or create a new one to discuss your ideas.
  2. Fork and Branch: Fork the repository and create a branch from the main branch to base your work.
  3. Start a Pull Request: Open a pull request and label it work in progress. Outline your contributions.
  4. Commit Your Changes: Commit your changes in logical units. Ensure you sign off on your commits using git commit -s -m "adding X to change Y".
  5. Engage: Push your changes to your branch and update your pull request with any new information or completed tasks. Engage with feedback from project maintainers.
  6. Final Review: Once completed, remove the work in progress label and request a final review from the maintainers.
  7. Approval: Your pull request must receive approval from at least two maintainers.

Commit Messages

Your commit messages should clearly articulate what changed and why:

  • Subject: Briefly describe what was changed.
  • Body: Explain why these changes were necessary.

Ensure the pull request description references the corresponding issue ID.

Developer Certificate of Origin

All contributions must adhere to the Developer Certificate of Origin (DCO) version 1.1, as documented at developercertificate.org. This implies that by submitting a contribution, you certify that you have the right to do so. Please include a "Signed-off-by" tag in every patch, which can be automated with a Git hook.

git commit -s -m "Describe your change"

Enjoy contributing, and happy coding!