diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..d608c829 --- /dev/null +++ b/.gitattributes @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72be07f9..5395d094 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/ @@ -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`. --- @@ -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. diff --git a/README.md b/README.md index c85fecf6..91130fa7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/index.html b/apps/dashboard/index.html similarity index 89% rename from index.html rename to apps/dashboard/index.html index ab46f36e..ecc9b210 100644 --- a/index.html +++ b/apps/dashboard/index.html @@ -11,6 +11,6 @@
- +