Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 1.92 KB

Contributing Guidelines

We welcome contributions! Before adding new functionality, open an issue first. Bug reports, fixes, and feedback are always appreciated.

Please take the time to review the Code of Conduct, which all contributors are subject to on this project.

Reporting Bugs

Before submitting a bug report:

  • Search existing issues and comment if one exists instead of creating a duplicate.

When submitting a bug report:

  • Use a clear title
  • List exact steps to reproduce the issue
  • Provide examples, links, or code snippets
  • Describe observed vs. expected behavior
  • Include screenshots or GIFs
  • Mention if the issue is consistent or intermittent and share environment details

Suggesting Enhancements

Before submitting an enhancement:

  • Search existing suggestions and comment on one instead of creating a duplicate.

When submitting an enhancement:

  • Use a clear title
  • Describe the enhancement step-by-step
  • Provide examples or code snippets
  • Explain current vs. expected behavior and its benefits

First Time Contributors

Check beginner and help-wanted issues to get started.

Pull Requests

Please follow these steps:

  1. Use the Pull Request template
  2. Follow the Code of Conduct
  3. Ensure all status checks pass before review

Note: Reviewers may request additional changes before merging.

Questions?

Connect with us through any of these channels:

For additional guidance, check out GitHub Flow.