Skip to content

docs: add CONTRIBUTING.md guide for new contributors (fixes #136)#585

Open
tungpham-dev wants to merge 1 commit into
tscircuit:mainfrom
tungpham-dev:add-contributing-guide
Open

docs: add CONTRIBUTING.md guide for new contributors (fixes #136)#585
tungpham-dev wants to merge 1 commit into
tscircuit:mainfrom
tungpham-dev:add-contributing-guide

Conversation

@tungpham-dev
Copy link
Copy Markdown

Closes #136

Adds a comprehensive CONTRIBUTING.md that was previously missing, covering:

  • Repository structure and the three element namespaces (source/schematic/pcb)
  • Local setup instructions using Bun
  • Step-by-step guide for adding new element types
  • Guidelines for modifying existing elements safely
  • Test writing examples with Vitest
  • PR submission checklist
  • Code style guide (Biome)

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.

Create a trace preview object to enable previewing autorouting results

1 participant