Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (72 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

107 lines (72 loc) · 2.5 KB

Contributing

Thanks for your interest, we welcome bug reports, improvements, and suggestions for enhancement.

Please take a moment to read this guide before opening an issue or pull request.

Ways to Contribute

You can help by:

  • Reporting bugs
  • Suggesting enhancements
  • Improving documentation
  • Submitting code changes

Before You Start

  • Check existing issues and pull requests to avoid duplicates
  • Make sure your idea aligns with the project’s goals
  • Be respectful and constructive (see CODE_OF_CONDUCT.md)

Reporting Bugs

When reporting a bug, please include:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Relevant logs, screenshots, or error messages
  • Environment details (OS, version, etc.)

Clear reports help us fix issues faster.

Suggesting Enhancements

Enhancement suggestions are welcome. Please:

  • Explain the problem you’re trying to solve
  • Describe the proposed solution
  • Note any alternatives you’ve considered
  • If possible, include a mock-up of your proposal

We cannot promise to do anything but are very interested in good ideas.

Pull Requests

General Guidelines

  • Keep changes focused and minimal
  • Follow existing coding style and conventions
  • Write clear, descriptive commit messages
  • Update documentation where relevant
  • Add or update tests if applicable

Process

  1. Fork the repository
  2. Create a branch from the default branch
  3. Make your changes
  4. Ensure the project builds/tests successfully
  5. Open a pull request with a clear description

Review Process

  • Use Copilot (or equivalent) to generate an initial review - address any sensible issues that are raised
  • Maintainers will review pull requests as time allows
  • Feedback may be requested before merging
  • Pull requests may be declined if they:
    • Are out of scope
    • Add unnecessary complexity
    • Conflict with the project’s direction

Please be patient, sometimes we have higher priorities which take precedence.

Code Style & Quality

  • Match the existing code style
  • Avoid unrelated refactors
  • Prefer clarity over cleverness - add comments where appropriate
  • Keep dependencies minimal - check licensing

Licensing

By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

Getting Help

If you have questions:

  • Open a discussion (if enabled)
  • Open an issue with a clear description

Thanks again for contributing — your help is appreciated!