dtourolle
6897b290ed
The repo had no SECURITY.md, CONTRIBUTING.md, code of conduct, or issue and PR templates. For a client that handles Jellyfin credentials and ships signed binaries, the missing one that actually matters is SECURITY.md: there was no stated way to report a vulnerability privately, so the only available channel was the public tracker. CONTRIBUTING.md documents the gates as they now stand, including the three ratchets and which direction each is allowed to move, and the two rules that surprise people: bug fixes start with a failing test, and Jellyfin's taxonomy stays in Rust. The bug template asks the three playback questions -- streaming or downloaded, transcoding or direct, music or video -- because those answers decide which of several very different code paths a report is about, and reconstructing them over several round trips is most of the cost of a playback bug report. docs/build/ci-operations.md is the missing operations manual: how to change the builder image and in what order (image pushed before the workflow that names it, or CI breaks), why tags are dated rather than :latest or per-SHA, what each secret is for, and what losing the updater private key would mean -- installed desktop clients only accept payloads signed by the key matching the public key they shipped with, so losing it means everyone reinstalls by hand. Disk exhaustion on the runner is documented as a manual check rather than a scheduled job. A daily job would occupy the only slot on a single-slot runner and pull the whole builder image to run `df` -- and `df` inside a container does not reliably describe the host's disk, so it would spend real build capacity reporting a number that might be wrong. What the doc records instead is the part that is actually hard to rediscover: the symptoms (cargo dying mid-link, docker refusing to pull, actions/cache quietly not saving) and that `docker volume prune` needs `-a` to touch named volumes, which is how it filled up unnoticed. Two things in these docs are stated plainly because they are true and were not written down anywhere: without branch protection every gate in the pipeline is advisory, and the Gitea instance -- canonical remote, signing secrets, registry, runner -- is not backed up by anything in this repository.
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
# Code of Conduct
|
|
|
|
## The short version
|
|
|
|
Be decent to people. Assume the person you are talking to is acting in good
|
|
faith and knows things you do not.
|
|
|
|
## What that means here
|
|
|
|
**Expected:**
|
|
|
|
- Criticise code, decisions and ideas — not the people who wrote them.
|
|
- Accept that "no" is a complete answer. This is a small project with a
|
|
maintainer who has finite time; a declined feature request is not a slight.
|
|
- Give people room to be new. Everyone was once confused by Tauri's IPC.
|
|
- Assume a bug report is someone trying to help, even when it arrives terse or
|
|
frustrated.
|
|
|
|
**Not accepted:**
|
|
|
|
- Harassment, personal attacks, or demeaning remarks — including about someone's
|
|
identity, background, or level of experience.
|
|
- Sexualised language or imagery, and unwelcome attention of any kind.
|
|
- Publishing someone's private information without their permission.
|
|
- Persistently derailing discussions, or badgering people who have already
|
|
answered you.
|
|
|
|
## Scope
|
|
|
|
This applies in the issue tracker, pull requests, commit messages and any other
|
|
project space, and to anyone taking part — maintainer included.
|
|
|
|
## Reporting
|
|
|
|
Email **duncan@tourolle.paris**. Reports are read by the maintainer and handled
|
|
privately.
|
|
|
|
Responses range from a quiet word through to removing comments or blocking an
|
|
account, depending on what happened. If a report concerns the maintainer, and
|
|
that makes reporting to them pointless, you are free to say so publicly — a
|
|
project this size has no separate committee to appeal to, and pretending
|
|
otherwise would be dishonest.
|
|
|
|
## Attribution
|
|
|
|
Adapted in spirit from the [Contributor Covenant](https://www.contributor-covenant.org),
|
|
shortened to what a single-maintainer project can actually honour.
|