Skip to content

Improved the contrubiting docs #667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Improved the contrubiting docs #667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,30 @@ To run specific tests, use appropriate flags such as:
- `./y.sh test --test-libcore`
- `./y.sh test --std-tests`
- `cargo test -- <name of test>`
##### Cargo tests
To run `cargo test`s, you need to do a few things.
First and foremost, set the correct `LD_LIBRARY_PATH` and `LIBRARY_PATH`.

You can find out this path by running `./y.sh build`.
You should see output like this:
```
[BUILD] build system
Finished `release` profile [optimized] target(s) in 0.01s
Using `EXAMPLE_PATH` as path for libgccjit
Finished `dev` profile [optimized + debuginfo] target(s) in 0.02s
```
Copy the path from that output, and use it to set `LD_LIBRARY_PATH` and `LIBRARY_PATH`.
```shell
export EXAMPLE_PATH=SOME_PATH
export EXAMPLE_PATH=SOME_PATH
```
Before running any of the cargo tests, you must also first run this command:
```sh
./y.sh test --mini-tests
```
It will build some of the dependencies neccesary for running tests.

##### `libgccjit` tests

Additionally, you can run the tests of `libgccjit`:

Expand Down