Updated CONTRIBUTING.MD for new package name and environment variables #930
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The on-boarding test instructions were out of date and pointed to the wrong package which no longer is called `coresimd` but rather `core_arch`. Additionally added text to explain how to handle the environment variables. The source for them was [this issue](rust-lang#875).
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Amanieu (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
Fixed the name of the flags environment variable name and added quotation marks as they are necessary
|
I would actually recommend using |
Rewrote the introduction to mainly talk about ci/run.sh and moved the prior instructions for "manual" test execution to the end for those unable to run ci/run.sh or wanting to run only specific tests
Added a reference to issue 931 to explain why the manual codegen tests may fail
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I tried to execute the instructions in CONTRIBUTING.MD I noticed that they actually don't work out of the box.
First, apparently the
coresimdpackage had been renamed at some point but the contributing.md was not updated, I fixed that.Additionally apparently since this documentation was written there was an update on how tests are invoked now requiring specific environment variables. I have added text to explain which those are and what they need to say to make
cargoandrustchappy.