Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (37 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 2.71 KB
Raw

Contributing to TicketWave HQ

Thanks for taking the time to consider a contribution.

Most repositories in the TicketWaveHQ organisation are private. This guide covers the public ones — currently openapi-spec and this .github repo. Individual public repos may override or extend this guidance.

Code of Conduct

All participation is governed by the Code of Conduct. Report unacceptable behaviour to conduct@ticketwavehq.com.

Before you open an issue or PR

  1. Search existing issues and PRs first. Many questions have already been answered.
  2. Check the repo-specific README. It usually describes scope, supported use cases, and known limitations.
  3. For security issues, do not open a public issue or PR. Follow SECURITY.md — email security@ticketwavehq.com.

Issues

Bug reports and feature suggestions are welcome on public repos. Use the issue templates where provided.

A good bug report includes:

  • What you expected to happen
  • What actually happened (logs, screenshots, error messages)
  • A minimal reproduction (versions, OS, browser, exact commands)
  • The repo and commit hash you are running

Pull requests

For public repos:

  1. Open an issue first for anything non-trivial. We would rather discuss approach before you spend time on a PR.
  2. One concern per PR. Smaller PRs are reviewed faster.
  3. Sign your commits where the repo enforces signing.
  4. Match the existing code style. Lint and formatter configs are checked in — please run them locally.
  5. Add or update tests when changing behaviour.
  6. Update docs when changing public API surface.
  7. Reference the issue in the PR description (e.g. Closes #123).

By submitting a PR you confirm that you have the right to license your contribution under the repo's existing licence (Apache-2.0 for openapi-spec; see each repo's LICENSE file).

What we will not accept

  • Drive-by formatting / linting-only PRs that touch many unrelated files
  • "AI-generated" PRs that have not been read and verified by a human contributor
  • Changes that remove safety, accessibility, or security features without a documented rationale

Questions

  • General questions: open a Discussion on the relevant repo, or email hello@ticketwavehq.com
  • Security: security@ticketwavehq.com (see SECURITY.md)
  • Conduct: conduct@ticketwavehq.com

Thanks again.

TicketWave HQ Ltd · Companies House 17143167 · England & Wales