blob: 17523888c7f9a6d1708388d39b86c42714e0fd1d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
## Configure CMake and Build
To configure cmake, run `cmake --preset default --fresh`.
To build, run `cmake --workflow --preset debug` or `cmake --workflow --preset release`.
## Formatting
Your PR needs to be formatted according to our coding style.
Run `./extras/formatting.sh` script to format your changes before creating a PR.
## Labeling your PR
All PRs needs to be labeled as either "pr: non-breaking" or "pr: breaking".
Label your PR as "pr: breaking" if you are introducing public API changes that breaks ABI compabibility,
or you are introducing changes to the Slang language that will cause the compiler to error out on existing Slang code.
It is rare for a PR to be a breaking change.
## Testing
Your PR should include a regression test for the bug you are fixing.
Normally, these tests present as a `.slang` file under `tests/` directory.
You will need to run your test with `slang-test tests/path/to/your-new-test.slang`.
|
