Skip to content

Commit c218a9e

Browse files
add: update readme docs
1 parent 2457554 commit c218a9e

3 files changed

Lines changed: 6 additions & 45 deletions

File tree

CLA.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Thank you for your interest in contributing to Codra! We are building a high-per
99
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).
1010

1111
- **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.
1312

1413
---
1514

@@ -51,24 +50,6 @@ npm run dev
5150

5251
---
5352

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-
7253
## 🧪 Testing
7354

7455
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
8869

8970
## 🚀 Pull Request Process
9071

91-
1. **Fork & Branch**: Create a feature branch from `main`.
72+
1. **Fork & Branch**: Create a feature branch from `dev`.
9273
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.
9678

9779
---
9880

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,11 @@
88

99
<p>
1010
<a href="LICENSE"><img alt="License: AGPL-3.0" src="https://img.shields.io/badge/license-AGPL--3.0-blue.svg"></a>
11-
<a href="https://github.com/devarshishimpi/codra/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/devarshishimpi/codra?style=flat&logo=github"></a>
1211
<a href="https://workers.cloudflare.com/"><img alt="Cloudflare Workers" src="https://img.shields.io/badge/runtime-Cloudflare%20Workers-f38020?logo=cloudflare"></a>
1312
<a href="https://react.dev/"><img alt="Built with React" src="https://img.shields.io/badge/dashboard-React-61dafb?logo=react&logoColor=111"></a>
1413
<a href="https://www.typescriptlang.org/"><img alt="TypeScript" src="https://img.shields.io/badge/language-TypeScript-3178c6?logo=typescript&logoColor=fff"></a>
1514
</p>
1615

17-
<br/>
18-
<br/>
19-
2016
<p>
2117
<a href="https://codra.run">Website</a>
2218
|
@@ -85,7 +81,7 @@ The full setup and operations guides live at [codra.run/docs](https://codra.run/
8581

8682
## Contributing
8783

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.
8985

9086
## License
9187

0 commit comments

Comments
 (0)