Skip to content

docs: add development setup instructions to README#114

Closed
murrayju wants to merge 1 commit intomainfrom
ox/add-readme
Closed

docs: add development setup instructions to README#114
murrayju wants to merge 1 commit intomainfrom
ox/add-readme

Conversation

@murrayju
Copy link
Member

Summary

  • Add a new Development section to README.md with setup instructions for contributors
  • Include prerequisites (Bun, Node.js)
  • Document setup steps and common development commands
  • Cross-reference CLAUDE.md for detailed guidelines

Test plan

  • Verified markdown formatting renders correctly
  • All checks pass (typecheck, lint, test)
  • README is accurate and helpful for new contributors

🤖 Generated with Claude Code

Add a new Development section with prerequisites, setup steps, and common commands for contributors. Includes links to CLAUDE.md for detailed development guidelines.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 17, 2026 19:25
@murrayju murrayju closed this Mar 17, 2026
@murrayju murrayju deleted the ox/add-readme branch March 17, 2026 19:25
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Ox Agent seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds contributor-focused development setup documentation to the project README to make local setup and common workflows easier to discover.

Changes:

  • Introduces a new Development section with prerequisites and setup steps
  • Documents common commands for typechecking, linting/formatting, testing, building, and running from source
  • Links to CLAUDE.md for more detailed contributor guidelines

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

cd ox

# Install dependencies
./bun install
# Install dependencies
./bun install

# Run all checks (typecheck, lint, test)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants