Skip to content

Commit 120dd53

Browse files
committed
Update README to match sample
1 parent 6dbb85f commit 120dd53

5 files changed

Lines changed: 135 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing
2+
3+
Thanks for contributing to WebUI Zig.
4+
5+
## Development Setup
6+
7+
- Zig `0.15.2+` (see `build.zig.zon`)
8+
- Linux, macOS, or Windows
9+
10+
Core commands:
11+
12+
```bash
13+
zig build
14+
zig build test
15+
zig build examples
16+
zig build parity-local
17+
```
18+
19+
## Branching and PRs
20+
21+
- Create focused PRs with one clear goal.
22+
- Include tests for behavior changes.
23+
- Keep public API changes documented in `MIGRATION.md` and `DOCUMENTATION.md`.
24+
- Do not commit binaries or cache outputs.
25+
26+
## Code Quality Rules
27+
28+
- Run `zig fmt` on changed Zig files.
29+
- Keep active runtime pure Zig.
30+
- Do not add `@cImport`, `translate-c`, or active C/C++ runtime source paths.
31+
- Prefer explicit, deterministic behavior over implicit fallbacks.
32+
33+
Static guards are enforced by build steps; keep them green.
34+
35+
## Testing Expectations
36+
37+
Before opening a PR, run:
38+
39+
```bash
40+
zig build test
41+
zig build examples
42+
zig build parity-local
43+
```
44+
45+
If your change affects launch/runtime behavior, also test at least one real GUI run:
46+
47+
```bash
48+
zig build run -Dexample=minimal -Drun-mode=webview,browser,web-url
49+
```
50+
51+
## Commit Guidance
52+
53+
- Use clear commit messages describing behavior changes.
54+
- Mention platform-specific impact (Linux/macOS/Windows) when relevant.
55+
- If a breaking API change is intentional, call it out explicitly.
56+
57+
## Reporting Regressions
58+
59+
Include:
60+
61+
- exact command used
62+
- OS + Zig version
63+
- expected behavior vs actual behavior
64+
- logs or stack trace

LICENCE

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This project uses the MIT license.
2+
3+
See `LICENSE` for the full text.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 WebUI Zig contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

SECURITY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are applied on the active development line.
6+
7+
| Version | Supported |
8+
|---|---|
9+
| main (latest) | yes |
10+
| older commits/tags | best effort |
11+
12+
## Reporting a Vulnerability
13+
14+
Please report vulnerabilities privately.
15+
16+
Preferred path:
17+
- GitHub Security Advisory / private security report for this repository.
18+
19+
If private reporting is unavailable, open an issue with minimal details and ask maintainers for a private channel before publishing exploit details.
20+
21+
Please include:
22+
23+
- affected version/commit
24+
- platform (Linux/macOS/Windows)
25+
- reproduction steps
26+
- impact assessment
27+
- proof-of-concept (if safe to share privately)
28+
29+
## Response Process
30+
31+
- We will acknowledge reports as soon as possible.
32+
- We will validate, prioritize, and prepare a fix.
33+
- Coordinated disclosure is preferred after a patch is available.
34+
35+
## Scope
36+
37+
In-scope areas include:
38+
39+
- WebSocket/HTTP transport behavior
40+
- RPC dispatch paths
41+
- process launch/termination behavior
42+
- TLS and certificate handling
43+
- profile path handling and filesystem interactions

build.zig.zon

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@
4747
"DOCUMENTATION.md",
4848
"MIGRATION.md",
4949
"CHANGELOG.md",
50+
"CONTRIBUTING.md",
51+
"SECURITY.md",
52+
"LICENSE",
53+
"LICENCE",
5054
"docs",
5155
"upstream_snapshot",
5256
},

0 commit comments

Comments
 (0)