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

Open Beginner friendly
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
playwright, python
Domain
documentation, testing

Research direction

Start with CONTRIBUTING.md and README.md, then compare the existing lint, frontend build, Ruff, pytest, and Playwright guidance with .github/workflows/ci.yml and frontend/e2e/orbit-ui.spec.ts. Add a short local-verification section that directs contributors to the relevant checks and explains the app and sample-data prerequisites for UI specs. Done means the commands match repository configuration and regular checks are clearly separated from locally prepared Playwright checks.

Written by the indexing model from the issue text.

Description

documentation good first issue help wanted

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
Dominant language
Python
Stars
5
Forks
10
Avg merge
6h 49m
Merged PRs (30d)
96

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from forthfate/openorbit

All issues in forthfate/openorbit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.