40aa6d9d1a
Tidy the repo root (README + LICENSE stay there per convention; everything else moves): - CONTRIBUTING.md, PROMISE.md, FOOTPRINT.md -> docs/ (alongside USER.md/DEVELOPMENT.md) - update the references: README links, the website site.json raw URLs, init.sh's 'see FOOTPRINT.md' comments -> docs/FOOTPRINT.md; drop the now-redundant CONTRIBUTING.md export-ignore (docs/ is already export-ignored). Refresh FOOTPRINT.md: it claimed 'everything lives under /docker', which is no longer true. Now describes the three relocatable roots (system/containers/backups) and makes explicit that the roots + manager name are baked into the helpers/unit/ wrapper at install (the privilege boundary) while this out-of-root footprint stays fixed by design. Uninstall sketch + sudoers/unit rows updated for the configurable manager. CONTRIBUTING/PROMISE were already current — left as-is. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: librelad <librelad@digitalangels.vip>
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# Contributing to LibrePortal
|
|
|
|
Thanks for wanting to help — LibrePortal is built in the open, and
|
|
contributions are genuinely welcome.
|
|
|
|
## Ground rules
|
|
|
|
- LibrePortal is **AGPLv3**. By contributing, your work is offered under that
|
|
same license (see the DCO below).
|
|
- **Match the surrounding code** — keep it simple and readable, and follow
|
|
the style of the file you're editing.
|
|
- Keep pull requests focused: one change per PR where you can.
|
|
|
|
## Developer Certificate of Origin (DCO)
|
|
|
|
We use the [DCO](https://developercertificate.org/) instead of a CLA — no
|
|
paperwork, just a sign-off certifying you have the right to submit your code.
|
|
|
|
Add a `Signed-off-by` line to every commit by committing with `-s`:
|
|
|
|
```bash
|
|
git commit -s -m "your message"
|
|
```
|
|
|
|
That appends:
|
|
|
|
```
|
|
Signed-off-by: Your Name <you@example.com>
|
|
```
|
|
|
|
By signing off, you agree to the DCO: that you wrote the patch (or otherwise
|
|
have the right to submit it) and that it may be included under the project's
|
|
AGPLv3 license.
|
|
|
|
## Bugs & ideas
|
|
|
|
Open an issue — clear steps to reproduce and your environment details help a
|
|
lot.
|
|
|
|
Thanks for helping keep self-hosting free and open. 🕊️
|