-
Notifications
You must be signed in to change notification settings - Fork 804
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.
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
docs: Make contributing.md slightly more clear for newer contributors #4080
Conversation
I'm definitely in favour of better guidance on which tests to run locally. I usually just do the basic |
|
||
Formatting, linting and tests are checked for all Rust and Python code. In addition, all warnings in Rust code are disallowed (using `RUSTFLAGS="-D warnings"`). | ||
#### Linting Python code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While the overview of possible commands is nice, I think it should go after line 104 (in the original file).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I agree. Have moved it there
Rearrange overview of commands
Yeah but I feel thats what bit me, because I was changing code in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is a good idea! Some other commands I use relatively often:
# to check all conditional compilation
nox -s check-feature-powerset
# to update UI tests
nox -s update-ui-tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great to me, thanks!
Hello dear maintainers:
Based on my new experience contributing for the 1-2 time, I think the following additions on the
Contributing.md
could help newer contributors to know exactly what commands they should execute to sort of check their PR beforeCI
flags it. Being more explicit over just waiting for theCI
to tell you has the advantage of:nox
orcargo test
doesnt run test code for--features
, but theCI
does, thus a contributor would assume everything goes alright until its flagged byCI
and the "angry" maintainer checks that such a basic check wasn't done by the contributor. :).These are just my 2 cents, thanks for the great repo :).
Edit: Since I am not familiar at all with the repo, I assume there are other tips and tricks that are checked in
CI
and for the code, so I could gladly add them if pointed out that its missed.