mirror of
https://github.com/lightpanda-io/browser.git
synced 2026-09-14 23:15:14 -04:00
Karl Seguin
8caaf7ad96
Assuming the conditions are met for -dev_fast to work (linux, debug, x86-64 without sanitizers), the -dev_fast now defaults to true. download-v8 make target always downloads the .a (as before) and on linux x86-64 it also downloads the .so.
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
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).
|
|
|
|
### Skip the V8 source build
|
|
|
|
By default the build compiles V8 from source, which takes several minutes. Run
|
|
`make download-v8` once to fetch the matching prebuilt libraries from the
|
|
[`zig-v8-fork`](https://github.com/lightpanda-io/zig-v8-fork/releases) releases
|
|
instead; later `make build` / `make test` pick them up automatically. On Linux
|
|
x86_64 this includes the shared flavor (`libc_v8.so`) used by `-Ddev_fast`
|
|
builds (defaults to true). Pass `-Ddev_fast=false` to get a static-V8 debug
|
|
build instead.
|
|
|
|
## 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).
|