Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.25 KB

File metadata and controls

30 lines (22 loc) · 1.25 KB

Contributing

Thanks for your interest in improving this project.

Before you start

  • Search existing issues and pull requests before opening a duplicate.
  • For a large change, open an issue first so the scope can be discussed.
  • Keep pull requests focused on one problem or improvement.
  • Do not commit secrets, API keys, generated credentials, personal data, or machine-specific files.

Development workflow

  1. Fork the repository and create a branch from main.
  2. Make the smallest change that solves the problem.
  3. Follow the existing code style and project structure.
  4. Build or run the project locally when possible.
  5. Run relevant tests or checks if the repository provides them.
  6. Update documentation when behavior or setup changes.
  7. Open a pull request explaining what changed and why.

Pull request checklist

  • The change is focused and understandable.
  • Existing behavior is not intentionally broken without explanation.
  • Relevant build/tests/checks were run when available.
  • Documentation was updated where needed.
  • No secrets or unrelated generated files are included.

Bug reports, documentation fixes, accessibility improvements, portability fixes, tests, and small maintainability improvements are especially welcome.