mirror of
https://github.com/lightpanda-io/browser.git
synced 2026-06-11 09:35:59 -04:00
827e696a4e
Reciprocal pointers so humans landing in CONTRIBUTING.md discover the agent/operational conventions in AGENTS.md, and agents landing in AGENTS.md discover the CLA gate and pre-PR checks. Adds a short Development section (test + fmt commands) and a Before-opening-a-PR checklist to CONTRIBUTING.md; CLA paragraph preserved verbatim and moved to its own section.
26 lines
850 B
Markdown
26 lines
850 B
Markdown
# Contributing
|
|
|
|
Lightpanda accepts pull requests through GitHub.
|
|
|
|
## Development
|
|
|
|
- Run the tests: `make test`
|
|
- Check formatting: `zig fmt --check ./*.zig ./**/*.zig`
|
|
|
|
See [AGENTS.md](AGENTS.md) for the full set of test, formatting, and code conventions (test filters, the leak-detection invariant, `@import` alias case, struct-init inference).
|
|
|
|
## Before opening a PR
|
|
|
|
- [ ] Tests pass (`make test`).
|
|
- [ ] Formatting is clean (`zig fmt --check ./*.zig ./**/*.zig`).
|
|
- [ ] CLA signed (see below).
|
|
|
|
## CLA
|
|
|
|
You have to sign our [CLA](CLA.md) during your first pull request process
|
|
otherwise we're not able to accept your contributions.
|
|
|
|
The process signature uses the [CLA assistant
|
|
lite](https://github.com/marketplace/actions/cla-assistant-lite). You can see
|
|
an example of the process in [#303](https://github.com/lightpanda-io/browser/pull/303).
|