Skip to content

Document local verification steps for frontend, backend, and UI changes #17

Description

@forthfate

Summary

The repository documents individual commands, but a first-time contributor does not have a quick guide to which checks to run for a documentation, frontend, backend, or UI end-to-end change.

Goal

Add a concise local-verification section to the contribution guide.

Scope

  • Describe the minimum relevant checks for documentation-only, frontend, and backend changes.
  • Include the existing lint, frontend build, Ruff, and pytest commands.
  • Briefly explain that the Playwright UI specs need a locally running app and the expected sample data; do not imply they run automatically in CI.
  • Keep the section short and link to existing instructions rather than duplicating them.

Acceptance criteria

  • A newcomer can choose the appropriate checks for a small contribution.
  • Commands match the scripts and configuration currently in this repository.
  • The guide clearly distinguishes regular automated checks from the locally prepared Playwright UI checks.
  • No application behavior or CI configuration changes are required.

Helpful files

  • CONTRIBUTING.md
  • README.md
  • frontend/e2e/orbit-ui.spec.ts
  • .github/workflows/ci.yml

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions