Skip to content

Document which tscircuit repositories to contribute to #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
junn-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document which tscircuit repositories to contribute to #650

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/contributing/overview-of-projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ sidebar_position: 2
description: Explore the key tscircuit repositories including core libraries, tools, and web components that power the ecosystem.
---

## Choosing a Repository to Contribute To

Use the project area to decide where an issue or pull request belongs.

| If you want to improve... | Start in this repository |
| ------------------------- | ------------------------ |
| React circuit primitives, rendering behavior, or generated Circuit JSON | [tscircuit/core](https://github.com/tscircuit/core) |
| Component prop definitions and TypeScript types | [tscircuit/props](https://github.com/tscircuit/props) |
| Footprint string parsing or generated pad geometry | [tscircuit/footprinter](https://github.com/tscircuit/footprinter) |
| Local project commands, package commands, or build/export flows | [tscircuit/cli](https://github.com/tscircuit/cli) |
| Browser editor workflows and project pages | [tscircuit/tscircuit.com](https://github.com/tscircuit/tscircuit.com) |
| Embedded previews used by docs and external sites | [tscircuit/runframe](https://github.com/tscircuit/runframe) |
| PCB rendering and interaction | [tscircuit/pcb-viewer](https://github.com/tscircuit/pcb-viewer) |
| 3D rendering and board previews | [tscircuit/3d-viewer](https://github.com/tscircuit/3d-viewer) |
| KiCad, EasyEDA, or JLCPCB import/export behavior | [tscircuit/kicad-component-converter](https://github.com/tscircuit/kicad-component-converter), [tscircuit/easyeda-converter](https://github.com/tscircuit/easyeda-converter), or [tscircuit/jlcsearch](https://github.com/tscircuit/jlcsearch) |
| Documentation, tutorials, and contributor guides | [tscircuit/docs](https://github.com/tscircuit/docs) |

When in doubt, open the issue in the repository closest to the user-facing bug
and link to related lower-level repositories in the description. Maintainers can
move or cross-link the issue if the fix belongs elsewhere.

| Repo | Description | Open Issues |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [tscircuit/core](https://github.com/tscircuit/core) | Core library that powers tscircuit, handles conversion of React components into circuit boards | [![GitHub issues](https://img.shields.io/github/issues/tscircuit/core)](https://github.com/tscircuit/core/issues) |
Expand Down
Loading