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
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# LF in the repository and on disk, on every platform. eol=lf rather than plain text=auto because
# this working tree is shared byte-for-byte through Dropbox: if one machine checked out CRLF the
# other would see the whole tree as modified after every sync.
* text=auto eol=lf

*.png binary
*.ico binary
14 changes: 9 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before we can merge your pull request, you must sign our Contributor License Agr

## 📦 Repository Layout

Codra is migrating to an npm workspace monorepo. The repository is structured into `apps/` (deployable entrypoints) and `packages/` (reusable modules):
Codra is an npm workspace monorepo. The repository is structured into `apps/` (deployable entrypoints) and `packages/` (reusable modules):

```text
packages/
Expand All @@ -31,7 +31,7 @@ apps/
└── dashboard/ # React SPA frontend (depends on ui, schema)
```

**Note:** We are incrementally migrating code from the legacy `src/` directory into this workspace structure. New logic should be placed in the appropriate `packages/` or `apps/` directory when possible.
**Note:** The `packages/*` modules are published to npm as `@codraoss/*`; the workspace consumes them as TypeScript source and only the published tarballs carry compiled output. Reusable logic belongs in a package, deployment wiring in `apps/worker`, and UI in `apps/dashboard`.

---

Expand Down Expand Up @@ -95,10 +95,14 @@ npm run typecheck

## 🚀 Pull Request Process

1. **Fork & Branch**: Create a feature branch from `main`.
Contributions are merged into `dev` first and reach `main` when a release is cut, so `main` always
reflects what is deployed and published. Pull requests opened against `main` will be asked to
retarget to `dev`.

1. **Fork & Branch**: Create a feature branch from `dev`.
2. **Atomic Commits**: Keep your commits focused and descriptive.
3. **Sync**: Ensure your branch is up to date with `main`.
4. **Target Branch**: Open pull requests against `main`.
3. **Sync**: Ensure your branch is up to date with `dev`.
4. **Target Branch**: Open pull requests against `dev`.
5. **PR Description**: Use the provided template (if available) or clearly explain the *what* and *why* of your changes.
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.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The full setup and operations guides live at [codra.run/docs](https://codra.run/

## Contributing

Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request against `main`. Codra uses a Contributor License Agreement for contributions.
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request against `dev`. Codra uses a Contributor License Agreement for contributions.

## License

Expand Down
2 changes: 1 addition & 1 deletion index.html → apps/dashboard/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/client/main.tsx"></script>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
Loading