Align CONTRIBUTING.md with the current development setup

Open Beginner friendly
#14 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
node.js, python
Domain
documentation

Research direction

Start with CONTRIBUTING.md and compare its development, pre-commit, and release instructions against README.md, pyproject.toml, and package.json. Update the documented versions, pnpm commands, and packaged-app command to match those files, then verify that no orbit-agent-console reference remains and all acceptance criteria are satisfied.

Written by the indexing model from the issue text.

Description

documentation good first issue help wanted

Summary

CONTRIBUTING.md still documents an older local-development path. It lists Python 3.11+, Node 20+, npm commands, and orbit-agent-console, while the current repository uses Python 3.13+, Node 24+, pnpm, and the orbit command.

This is a documentation-only contribution with no product-code changes required.

Scope

  • Update the required Python and Node.js versions to match the project configuration and README.
  • Replace obsolete npm commands with the current pnpm commands.
  • Replace the obsolete packaged-app command with the current orbit run command.
  • Keep the development, pre-commit, and release instructions internally consistent.

Acceptance criteria

  • The development instructions agree with README.md, pyproject.toml, and package.json.
  • No reference to the removed orbit-agent-console command remains.
  • Commands are copyable and use the repository's declared package manager.
  • No production source code changes are needed.

Helpful files

  • CONTRIBUTING.md
  • README.md
  • pyproject.toml
  • package.json

Questions are welcome—please leave a comment if any command or version requirement is unclear.

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.