Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 6 additions & 3 deletions .clauderc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Do not worry about migrations (client side or backend) unless specifically instr
- Prefer modern ES6+ syntax and features
- Use import aliases from jsconfig.json (see ui-components.mdc)
- Prefer config files over hardcoding values
- Place plans in `docs/plans/` directory
- Place plans/audits in `packages/docs/audits/` directory
- Ensure browser compatibility (Safari is usually problematic)

### File Organization
Expand All @@ -58,12 +58,12 @@ Comments should not repeat what the code is saying. Instead, reserve comments fo

```js
// Bad - narrates what the code does
retries += 1
retries += 1;

// Good - explains why
// Some APIs occasionally return 500s on valid requests. We retry up to 3 times
// before surfacing an error.
retries += 1
retries += 1;
```

**When to Comment:**
Expand Down Expand Up @@ -93,6 +93,7 @@ import { Dialog } from '@/components/ark/Dialog.jsx';
```

See `ui-components.mdc` for detailed component usage patterns.

### Database Migrations

- Use DrizzleKit to generate new migrations when necessary
Expand Down Expand Up @@ -131,6 +132,7 @@ See `solidjs.mdc` for detailed reactivity patterns and examples.
## Specialized Rule Files

For detailed patterns, see:

- `solidjs.mdc` - Reactivity patterns, props, stores, primitives
- `api-routes.mdc` - API route patterns, validation, database operations
- `error-handling.mdc` - Error handling patterns (frontend + backend)
Expand All @@ -140,6 +142,7 @@ For detailed patterns, see:
### Complex Area Rules

For specific complex areas, see:

- `yjs-sync.mdc` - Yjs synchronization, connection management, sync operations
- `reconciliation.mdc` - Checklist reconciliation, multi-part questions, comparison logic
- `pdf-handling.mdc` - PDF upload, caching, Google Drive integration
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Do not worry about migrations (client side or backend) unless specifically instr
- Prefer modern ES6+ syntax and features
- Use import aliases from jsconfig.json (see ui-components.mdc)
- Prefer config files over hardcoding values
- Place plans in `docs/plans/` directory
- Place plans/audits in `packages/docs/audits/` directory
- Ensure browser compatibility (Safari is usually problematic)

### File Organization
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ openapi.json
packages/workers/src/__tests__/migration-sql.js

# Temp files
/docs/plans*
/docs/audits*
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@
CoRATES is a web application designed to streamline the entire quality and risk-of-bias appraisal process with intuitive workflows, real-time collaboration, and automation, creating greater transparency and efficiency at every step. Built for researchers conducting evidence synthesis, it enables real-time collaboration, offline support, and PDF annotation.

<p align="center">
<img src="./docs/assets/marketing.png" alt="Home Page" width="800" />
<img src=".github/assets/marketing.png" alt="Home Page" width="800" />
</p>

## Getting Started

> See the detailed [Contributing Guide](CONTRIBUTING.md) for step-by-step setup instructions.
> See the detailed [Contributing Guide](.github/CONTRIBUTING.md) for step-by-step setup instructions.

> See the [Code of Conduct](.github/CODE_OF_CONDUCT.md).

> See detailed [Documentation](packages/docs/README.md).

## Tech Stack

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"eslint-plugin-unicorn": "^62.0.0",
"prettier": "^3.7.4",
"prettier-plugin-tailwindcss": "^0.7.2",
"turbo": "^2.7.2",
"turbo": "^2.7.3",
"wrangler": "^4.56.0"
},
"engines": {
Expand Down
43 changes: 43 additions & 0 deletions packages/docs/audits/agent-ready-prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Act as a senior software engineer who regularly works with AI coding agents (e.g., Claude Code, Cursor, Copilot) on large production codebases.

Audit my codebase to evaluate how effectively AI coding agents can understand, navigate, and safely modify it. Provide a prioritized report focusing on:

1. Project Structure & Discoverability
• Clarity of folder structure and boundaries
• Whether key entry points, services, and domains are easy to locate
• Presence (or absence) of README files at repo and subdirectory levels

2. Naming & Semantic Clarity
• File, function, and variable names that help or hinder AI understanding
• Consistency of naming across layers
• Ambiguous or overloaded concepts that confuse automated reasoning

3. Code Organization & Modularity
• Size and responsibility of files and functions
• Hidden coupling or cross-cutting logic
• Opportunities to make changes more localized and safer

4. Comments, Docs, and Intent Signaling
• Whether comments explain why, not just what
• Presence of architectural or invariants documentation
• Missing high-level explanations that would help an agent reason correctly

5. Patterns & Consistency
• Repeated patterns that could be standardized
• One-off implementations that increase hallucination risk
• Framework or library usage consistency

6. Safety for Automated Changes
• Areas where small changes have large or non-obvious side effects
• Missing guardrails (tests, assertions, types)
• Files or subsystems that should be marked “do not touch without context”

7. Tests & Feedback Loops
• Whether tests are easy for agents to run and interpret
• Quality of failure messages and assertions
• Gaps that make automated refactors risky

8. Tooling & Agent Hints
• Linting, formatting, and type-checking clarity
• Opportunities to add AI-oriented docs (e.g., CONTRIBUTING, AGENTS.md)
• Suggestions for comments or metadata that guide AI behavior
Loading