Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (28 loc) · 1001 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1001 Bytes
Raw

Contributing

Thank you for considering a contribution to OSIPY Dashboard.

Ways To Contribute

  • Report reproducible frontend bugs.
  • Suggest dashboard workflows for OSIPY users.
  • Improve documentation, copy, and accessibility.
  • Add tests or validation for user-facing behavior.
  • Review design, architecture, and handover documentation.

Development Workflow

  1. Discuss substantial changes with maintainers before implementation.
  2. Create a branch from main.
  3. Make a small, reviewable change.
  4. Add or update tests and documentation when behavior changes.
  5. Run the relevant checks locally.
  6. Open a pull request using the PR template.

Local Checks

bun install
bun run check
bun run lint
bun run build

Pull Request Expectations

  • The purpose of the change is clear.
  • Tests or validation steps are included when relevant.
  • Documentation is updated when behavior changes.
  • New dependencies are justified.
  • Known limitations and follow-up work are described.