ThreadCount
f72f0626b0
Release / release (push) Has been skipped
Uniform stock management for healthcare linen rooms: the coordinator app, the phone counter and the staff app, for your own server. Built from 794bab5 on 2026-09-16. Licensed under the Functional Source License (FSL-1.1-ALv2).
44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
# Contributing
|
|
|
|
Bug reports and patches are welcome. The product is written for a real linen room, so the most
|
|
useful thing you can send is what went wrong in yours: what you were doing, what you expected, and
|
|
what happened instead.
|
|
|
|
## Reporting
|
|
|
|
- **A bug or a question:** open an issue.
|
|
- **A security problem:** email security@threadcount.tech instead. Please don't open a public issue
|
|
for it.
|
|
|
|
## Sending a patch
|
|
|
|
1. Open an issue first for anything beyond a small fix, so the approach can be agreed before you
|
|
spend an evening on it.
|
|
2. Keep the change focused, and match the surrounding code — comments that explain *why*, plain
|
|
words on screen, no dependency added without a reason.
|
|
3. Say how you tested it. There is no CI on this repository; a description of what you ran is what
|
|
a reviewer has to go on.
|
|
|
|
## Sign your commits (DCO)
|
|
|
|
Every commit needs a `Signed-off-by` line, which `git commit -s` adds for you:
|
|
|
|
```
|
|
Signed-off-by: Your Name <your.email@example.com>
|
|
```
|
|
|
|
That line means you agree to the [Developer Certificate of Origin 1.1](https://developercertificate.org/):
|
|
that you wrote the patch, or have the right to submit it under this project's licence, and that
|
|
you understand it will be public and kept in the record.
|
|
|
|
It is a sign-off, not a copyright assignment — you keep the copyright in your work, and it is
|
|
contributed under the project's licence (AGPL-3.0-only).
|
|
|
|
## Licence
|
|
|
|
Contributions are accepted under the [AGPL-3.0-only](LICENSE) licence that covers the Community
|
|
edition. The ThreadCount name and logo are not covered by it.
|
|
|
|
A commercial licence of the same code is offered to organisations that cannot use the AGPL. If your
|
|
patch is merged, it stays under the AGPL here; it is only ever relicensed with your agreement.
|