Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.97 KB
Raw

Contributing to puppeteer-replay-runner

Thank you for your interest in puppeteer-replay-runner. We highly value your contributions and are excited to see your involvement.

Ways to Get Involved

Please adhere to the guidelines outlined below. If you need assistance, feel free to open an issue.

Report a Bug

Before reporting a bug, please ensure no existing issue already addresses the problem. If an existing issue is found, contribute by adding your comments or additional information.

To report a new bug:

  • Open an issue summarizing the bug and apply the "bug" label.
  • If you also have a fix, fantastic! Please submit a pull request as outlined in the Contribute Code section.

Suggest a Feature

To suggest a new feature:

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

Contribute Code

Workflow for Code Contributions

  1. Review the list of open issues. Choose an existing issue to work on, or create a new one to discuss your ideas.
  2. It is beneficial to discuss your plans before starting work to align your efforts with project goals.
  3. Fork the repository on GitHub.
  4. Create a branch from the master branch to base your work.
  5. Initiate a new pull request, label it as work in progress, and detail your contributions.
  6. Commit your changes in logical and manageable units.
  7. Ensure your commits include a sign-off (git commit -s -m "your commit message").
  8. Write clear and detailed commit messages.
  9. Push your changes to your branch in your fork and keep your pull request updated.
  10. Engage with feedback from project maintainers during the review process.
  11. Once complete, remove the work in progress label and notify maintainers for final review.

Commit Messages

Commit messages should clearly articulate what changed and why:

  • Subject: Briefly state what has changed.
  • Body: Provide a detailed explanation about why these changes were necessary.

Your pull request description should link back to the corresponding issue id for full context.

Sign Your Work - Developer Certificate of Origin

All contributions must adhere to the Developer Certificate of Origin (DCO) version 1.1, which can be found at developercertificate.org. This certification confirms your rights to submit the changes. Including a "Signed-off-by" tag in each commit is a way to certify your agreement. This can be automated with a Git hook:

git commit -s -m "Describe your change"

Enjoy contributing, and happy coding!