improve doc for new contributors #586
Conversation
|
@antoyo waiting on a review for this too |
|
It might take a few more days before I can get to review this. |
|
There's a conflict, so please rebase on the master branch and resolve the conflict. |
g4titanx
force-pushed
the
contributing
branch
from
43dedcd to
2fc138f
Compare
done, sorry for the delay. |
| To run specific tests, use appropriate flags such as: | ||
| - `./y.sh test --test-libcore` | ||
| - `./y.sh test --std-tests` | ||
|
|
There was a problem hiding this comment.
Please also mention how to run the tests in this directory.
| - `./y.sh test --test-libcore` | ||
| - `./y.sh test --std-tests` | ||
|
|
||
| Additional test running options: |
There was a problem hiding this comment.
To make it clearer, please specify that the following runs the tests of libgccjit.
| - `CG_GCCJIT_DUMP_MODULE`: Dumps a specific module | ||
| - `CG_GCCJIT_DUMP_TO_FILE`: Creates C-like representation | ||
|
|
||
| Full list of debugging options can be found in the README. |
There was a problem hiding this comment.
Please add a link to the section in the README.
| ## Making Contributions | ||
|
|
||
| ### Finding Issues to Work On | ||
| 1. Look for issues labeled with `good-first-issue` or `help-wanted` |
There was a problem hiding this comment.
| 1. Look for issues labeled with `good-first-issue` or `help-wanted` | |
| 1. Look for issues labeled with `good first issue` or `help wanted` |
and please also make those a link.
| ### Finding Issues to Work On | ||
| 1. Look for issues labeled with `good-first-issue` or `help-wanted` | ||
| 2. Check the [progress report](https://blog.antoyo.xyz/rustc_codegen_gcc-progress-report-34#state_of_rustc_codegen_gcc) for larger initiatives | ||
| 3. Consider improving documentation or investigate [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except failing-ui-tests12.txt) |
There was a problem hiding this comment.
| 3. Consider improving documentation or investigate [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except failing-ui-tests12.txt) | |
| 3. Consider improving documentation or investigating [failing tests](https://github.com/rust-lang/rustc_codegen_gcc/tree/master/tests)(except `failing-ui-tests12.txt`) |
| @@ -40,7 +53,7 @@ to do a few more things. | |||
| To build it (most of these instructions come from [here](https://gcc.gnu.org/onlinedocs/jit/internals/index.html), so don't hesitate to take a look there if you encounter an issue): | |||
|
|
|||
| ```bash | |||
| $ git clone https://github.com/rust-lang/gcc | |||
| $ git clone https://github.com/antoyo/gcc | |||
There was a problem hiding this comment.
Please revert this change as the main repo is now under rust-lang.
| Note: **This requires a patched libgccjit in order to work. | ||
| You need to use my [fork of gcc](https://github.com/antoyo/gcc) which already includes these patches.** |
There was a problem hiding this comment.
To make this clearer, perhaps mention that the default example config download libgccjit from the CI so this will use the fork automatically.
this PR fixes issue #562