External/roboco
1
0
Fork 0
mirror of https://github.com/rennf93/roboco.git synced 2026-08-03 07:23:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: reflow hard-wrapped prose to one line per paragraph

Browse Source 
Markdown and editors soft-wrap on their own, so the manual ~75-char line
breaks across the docs added nothing but noise. Join wrapped prose, list
items, and paragraphs into single lines across 67 docs — README, CLAUDE.md,
deployment, usage, the RAG knowledge base, and the agent role prompts.
Whitespace-only: code fences, tables, and blockquote alerts are byte-identical
and the change is token-verified (no content altered). Applied with a
deterministic reflow tool (committed separately).

Also lands two doc edits that were awaiting commit: the measured under-load
resource numbers in usage.md and the pr_reviewer additions to the
org-structure RAG doc.
This commit is contained in:
Renn F
2026-06-16 23:18:55 +02:00
parent 640a964b88
commit f48106cbb6
67 changed files with 504 additions and 1593 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+13 -37
View File
@@ -1,37 +1,22 @@
# Contributing to RoboCo
Thanks for your interest in contributing. This document explains the
contribution workflow and the licensing terms your contributions are made
under.
Thanks for your interest in contributing. This document explains the contribution workflow and the licensing terms your contributions are made under.
## License of contributions
RoboCo is licensed under the **GNU Affero General Public License v3.0**
(AGPL-3.0). Your contributions are accepted into the project under that
license.
RoboCo is licensed under the **GNU Affero General Public License v3.0** (AGPL-3.0). Your contributions are accepted into the project under that license.
## Contributor License Agreement (CLA)
Before your first pull request can be merged, you must sign the project's
[Contributor License Agreement](./CLA.md).
Before your first pull request can be merged, you must sign the project's [Contributor License Agreement](./CLA.md).
**Why a CLA?** The AGPL keeps the published project open. The CLA grants the
maintainer the additional rights needed to keep the project's future flexible
— for example, to offer a dual-licensed or commercial edition later, or to
re-license the codebase if that ever becomes necessary. Without it, the
project would be permanently locked to exactly one license, because each
contributor would retain sole copyright over their contribution.
**Why a CLA?** The AGPL keeps the published project open. The CLA grants the maintainer the additional rights needed to keep the project's future flexible — for example, to offer a dual-licensed or commercial edition later, or to re-license the codebase if that ever becomes necessary. Without it, the project would be permanently locked to exactly one license, because each contributor would retain sole copyright over their contribution.
Signing the CLA does **not** transfer ownership of your work away from you —
you keep your copyright. It grants the maintainer (and the maintainer's
successors and assigns) a broad license to use, distribute, and re-license
your contribution. See [`CLA.md`](./CLA.md) for the exact terms.
Signing the CLA does **not** transfer ownership of your work away from you — you keep your copyright. It grants the maintainer (and the maintainer's successors and assigns) a broad license to use, distribute, and re-license your contribution. See [`CLA.md`](./CLA.md) for the exact terms.
### How signing works
The first time you open a pull request, the CLA Assistant bot will comment with
a link and ask you to confirm agreement by posting a one-line comment on the
PR. This is a one-time action; subsequent PRs are recognized automatically.
The first time you open a pull request, the CLA Assistant bot will comment with a link and ask you to confirm agreement by posting a one-line comment on the PR. This is a one-time action; subsequent PRs are recognized automatically.
## Development workflow
@@ -43,27 +28,22 @@ PR. This is a one-time action; subsequent PRs are recognized automatically.
make quality # ruff format check, ruff check, mypy, pytest --cov-fail-under=80
```
For the frontend (`panel/`):
For the frontend (`panel/`):
```bash
pnpm format && pnpm lint && pnpm typecheck && pnpm test
```
4. **Sign your commits.** `master` requires *verified* signatures, so set up
commit signing before you push — see [Signing your commits](#signing-your-commits).
5. Open a pull request with a clear description of the change and its
motivation.
4. **Sign your commits.** `master` requires *verified* signatures, so set up commit signing before you push — see [Signing your commits](#signing-your-commits).
5. Open a pull request with a clear description of the change and its motivation.
## Commit messages
Keep commits focused and descriptive. Do not include AI-generated attribution
footers or co-author trailers.
Keep commits focused and descriptive. Do not include AI-generated attribution footers or co-author trailers.
## Signing your commits
`master` is protected by a rule that **every commit must carry a verified
signature**. Set this up once and it's automatic from then on; otherwise a
maintainer has to bypass the rule to merge your PR.
`master` is protected by a rule that **every commit must carry a verified signature**. Set this up once and it's automatic from then on; otherwise a maintainer has to bypass the rule to merge your PR.
> This is *cryptographic* signing (`git commit -S`, shown as **Verified** on
> GitHub) — not the `-s` Developer Certificate of Origin *sign-off* trailer. The
@@ -77,13 +57,9 @@ git config --global user.signingkey ~/.ssh/id_ed25519.pub # or id_rsa.pub
git config --global commit.gpgsign true
```
Then add that **same public key** to GitHub a second time as a signing key:
**Settings → SSH and GPG keys → New SSH key → Key type: _Signing Key_**. (GPG
signing also works if you prefer it.)
Then add that **same public key** to GitHub a second time as a signing key: **Settings → SSH and GPG keys → New SSH key → Key type: _Signing Key_**. (GPG signing also works if you prefer it.)
Your next commit will be signed; confirm with `git log --show-signature -1`. If
you already pushed **unsigned** commits on your PR, re-sign the whole branch and
force-push:
Your next commit will be signed; confirm with `git log --show-signature -1`. If you already pushed **unsigned** commits on your PR, re-sign the whole branch and force-push:
```bash
git rebase --exec "git commit --amend --no-edit -S" origin/master