You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-23Lines changed: 5 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,6 @@ Thank you for your interest in contributing to Codra! We are building a high-per
9
9
Before we can merge your pull request, you must sign our Contributor License Agreement. This is a quick process that takes about 10 seconds and ensures that your contributions can be included under our dual-licensing model (AGPL-3.0 for the core).
10
10
11
11
-**How to sign:** Visit [codra.run/cla](https://codra.run/cla) or follow the link provided by the automated GitHub check on your PR.
12
-
-**Why?** It protects the project's ability to remain sustainable while staying open source.
13
12
14
13
---
15
14
@@ -51,24 +50,6 @@ npm run dev
51
50
52
51
---
53
52
54
-
## 📐 Design & Coding Standards
55
-
56
-
We aim for a **"Precise, Understated, Dependable"** aesthetic. Please refer to [`.impeccable.md`](.impeccable.md) for full design context.
57
-
58
-
### Design Principles
59
-
1.**Clarity over cleverness**: Information should be immediately legible.
60
-
2.**Restraint is a feature**: Use our signature lime (`oklch(94% 0.23 115)`) sparingly for meaning.
61
-
3.**Trust through density**: Developer tools should pack information confidently without clutter.
62
-
4.**Typography**: Use **Figtree** for UI and **JetBrains Mono** for code.
63
-
64
-
### Tech Stack Standards
65
-
-**TypeScript**: Strict mode is enabled. Avoid `any` at all costs.
66
-
-**Styling**: Tailwind CSS 4.0. Use OKLCH for colors to maintain perceptual uniformity.
67
-
-**Validation**: Use **Zod** for all schema validation (API requests, Queue messages).
68
-
-**Icons**: Use **Lucide React**.
69
-
70
-
---
71
-
72
53
## 🧪 Testing
73
54
74
55
We use **Vitest** for unit and integration testing. `npm test` runs the non-database tests by default and automatically enables DB integration tests when `TEST_DATABASE_URL` points at a disposable Postgres database.
@@ -88,11 +69,12 @@ npm run typecheck
88
69
89
70
## 🚀 Pull Request Process
90
71
91
-
1.**Fork & Branch**: Create a feature branch from `main`.
72
+
1.**Fork & Branch**: Create a feature branch from `dev`.
92
73
2.**Atomic Commits**: Keep your commits focused and descriptive.
93
-
3.**Sync**: Ensure your branch is up to date with `main`.
94
-
4.**PR Description**: Use the provided template (if available) or clearly explain the *what* and *why* of your changes.
95
-
5.**CLA Check**: Once you open the PR, an automated check will verify your CLA status. If you haven't signed yet, follow the link in the check output.
74
+
3.**Sync**: Ensure your branch is up to date with `dev`.
75
+
4.**Target Branch**: Open pull requests against `dev`.
76
+
5.**PR Description**: Use the provided template (if available) or clearly explain the *what* and *why* of your changes.
77
+
6.**CLA Check**: Once you open the PR, an automated check will verify your CLA status. If you haven't signed yet, follow the link in the check output.
@@ -85,7 +81,7 @@ The full setup and operations guides live at [codra.run/docs](https://codra.run/
85
81
86
82
## Contributing
87
83
88
-
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Codra uses a Contributor License Agreement for contributions.
84
+
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request against `dev`. Codra uses a Contributor License Agreement for contributions.
0 commit comments