LibrePortal/docs/contributing/contributing.md
librelad 30612a0d87 docs: organize docs/ into purpose folders with consistent naming
Sort docs/ into guide/ contributing/ architecture/ roadmap/ and rename
to consistent kebab-case (USER->guide/install-and-use, FOOTPRINT->
architecture/system-footprint, frontend-modularization->architecture/
webui-architecture, etc.). Add a docs/README.md index and a docs/
CONTRIBUTING.md pointer so the forge still surfaces the contributing
guide. Fix every reference (README, init.sh comments, frontend code
comments, and the USER<->DEVELOPMENT cross-links). History preserved
via git mv. Root stays README.md + CLAUDE.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: librelad <librelad@digitalangels.vip>
2026-05-31 00:48:38 +01:00

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. 🕊️