-
Notifications
You must be signed in to change notification settings - Fork 21
Add instructions for Statsify project setup #855
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.
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
ugcodrr
wants to merge
4
commits into
main
Choose a base branch
from
gh-review-instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+15
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Copilot instructions — Statsify | ||
|
|
||
| Statsify is a monorepo for a Hypixel/Minecraft-focused **Discord bot** and its supporting services (API, web site, support bot, skin renderer, etc). | ||
|
|
||
| ## Running an app (NOT needed for most changes) | ||
| Apps need external services and secrets, so avoid running them just to validate code; rely on build + lint + types + tests instead. | ||
|
|
||
| ## Project layout | ||
| - **`apps/`** — runnable services, each with a root `package.json` workspace script (`pnpm <name> <cmd>`): `api`, `discord-bot`, `support-bot`, `verify-server`, `site` (Next.js), `scripts`, etc. | ||
| - **`packages/`** — non-runnable shared libraries named `@statsify/{name}`: `api-client`, `assets`, `discord`, `logger`, `math`, `rendering`, `schemas`, `skin-renderer` (Rust/WASM), `util`, etc. | ||
| - Put shared logic in a package; do not duplicate it across apps. Packages must not be runnable. | ||
| - **Per-workspace scripts** are typically uniform: `build` (SWC → `dist/`), `test:types` (`tsc --noEmit`), `lint` (`eslint`). Exceptions: `apps/site` (Next.js, no `test:types`), `apps/scripts` (no `build`/`test:types`), `packages/skin-renderer` (Rust/NAPI/WASM build; `lint` runs `cargo fmt && cargo clippy`). | ||
| - **Config (all at root):** `eslint.config.js`, `tsconfig.base.json` (NodeNext, strict, `target: esnext`), `turbo.json`, `.swcrc`, `vitest.shared.ts`, `vitest.workspace.ts`, `rustfmt.toml`, `Cargo.toml` (workspace = `packages/skin-renderer`). Build outputs (`dist`, `.next`, `pkg`) and `node_modules` are git-ignored and eslint-ignored. | ||
|
|
||
| When reviewing, flag code that is inconsistent with surrounding patterns, or that isn't fast or scalable. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.