Skip to content

Commit 0925458

Browse files
The127claude
andcommitted
docs: tighten the README
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: karo <karolin.kostial@gmail.com>
1 parent b9f9a6a commit 0925458

1 file changed

Lines changed: 28 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,11 @@ discoverable disk images and the files systemd-sysupdate consumes. Every
77
image is booted and checked before it leaves the build.
88

99
miso builds images. What happens on the machine afterwards (applying
10-
updates, configuration, first boot logic) is out of scope. miso provides
11-
the data, you do it your way.
10+
updates, configuration, first boot logic) is out of scope. miso emits
11+
standard systemd formats and leaves the rest to whoever runs the machine.
1212

13-
> **Status: early development.** Nothing here is usable yet.
14-
15-
## Usage
16-
17-
Not yet. The interface will be documented here once it exists.
18-
19-
## Contributing
20-
21-
Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md). In
22-
short: commits follow plain Conventional Commits (`type: description`, no
23-
scopes) and must be DCO signed off (`git commit -s`). Both rules are
24-
enforced by git hooks.
25-
26-
## AI-assisted contributions
27-
28-
AI-assisted contributions need to follow these rules:
29-
30-
- **Disclose it.** Commits with AI-generated code carry a co-author
31-
trailer, e.g. `Co-Authored-By: Claude <noreply@anthropic.com>`.
32-
- **You are the author.** The contributor is fully responsible for
33-
AI-generated code: its correctness, its license compatibility, and the
34-
DCO sign-off certifying the right to submit it. "The AI wrote it" is
35-
never an excuse.
36-
- **Review it yourself, before pushing.** Submit only code you have read,
37-
understood, and could explain and defend in review as your own.
38-
39-
## Security
40-
41-
Please report vulnerabilities privately, see [SECURITY.md](SECURITY.md).
13+
> **Status: early development.** Nothing here is usable yet. Usage will be
14+
> documented here once the interface exists.
4215
4316
## Development setup
4417

@@ -66,6 +39,30 @@ After cloning, run the one-time setup. It activates the git hooks:
6639
just setup
6740
```
6841

42+
## Contributing
43+
44+
Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md). In
45+
short: commits follow plain Conventional Commits (`type: description`, no
46+
scopes) and must be DCO signed off (`git commit -s`). Both rules are
47+
enforced by git hooks.
48+
49+
## AI-assisted contributions
50+
51+
AI-assisted contributions need to follow these rules:
52+
53+
- **Disclose it.** Commits with AI-generated code carry a co-author
54+
trailer, e.g. `Co-Authored-By: Claude <noreply@anthropic.com>`.
55+
- **You are the author.** The contributor is fully responsible for
56+
AI-generated code: its correctness, its license compatibility, and the
57+
DCO sign-off certifying the right to submit it. "The AI wrote it" is
58+
never an excuse.
59+
- **Review it yourself, before pushing.** Submit only code you have read,
60+
understood, and could explain and defend in review as your own.
61+
62+
## Security
63+
64+
Please report vulnerabilities privately, see [SECURITY.md](SECURITY.md).
65+
6966
## License
7067

7168
miso is licensed under [AGPL-3.0-or-later](LICENSE).

0 commit comments

Comments
 (0)