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. |
antoyo
left a comment
antoyo
left a comment
There was a problem hiding this comment.
Nice job.
Here's a few suggestions for improvement.
|
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. |
antoyo
left a comment
antoyo
left a comment
There was a problem hiding this comment.
A few nitpicks, but this looks very good. Thanks!
Sorry for the delay: I've been very busy lately.
|
|
||
| - Matrix: Join our [Matrix channel](https://matrix.to/#/#rustc_codegen_gcc:matrix.org) | ||
| - IRC: Join us on [IRC](https://web.libera.chat/#rustc_codegen_gcc) | ||
| - GitHub Issues: For bug reports and feature discussions |
There was a problem hiding this comment.
Maybe add a link to github issues?
| ### Common Development Tasks | ||
|
|
||
| #### Running Specific Tests | ||
| To run specific tests, use appropriate flags such as: |
There was a problem hiding this comment.
For coherency with the rest, please add an empty line before and after this one.
| ``` | ||
|
|
||
| #### Debugging Tools | ||
| The project provides several environment variables for debugging: |
| The project provides several environment variables for debugging: | ||
| - `CG_GCCJIT_DUMP_GIMPLE`: Dump the GIMPLE IR | ||
| - `CG_RUSTFLAGS`: Additional Rust flags | ||
| - `CG_GCCJIT_DUMP_MODULE`: Dumps a specific module |
There was a problem hiding this comment.
Before you used Dump, which is not the same verb form.
| - `CG_GCCJIT_DUMP_GIMPLE`: Dump the GIMPLE IR | ||
| - `CG_RUSTFLAGS`: Additional Rust flags | ||
| - `CG_GCCJIT_DUMP_MODULE`: Dumps a specific module | ||
| - `CG_GCCJIT_DUMP_TO_FILE`: Creates C-like representation |
There was a problem hiding this comment.
Before you used Dump, which is not the same verb form.
| 1. Fork the repository and create a new branch | ||
| 2. Make your changes with clear commit messages |
There was a problem hiding this comment.
Are 1. and 2. really necessary to specify?
There was a problem hiding this comment.
I guess it doesn't hurt to keep this.
|
Thanks @g4titanx for your contribution! |
3 participants
this PR fixes issue #562