Add Helpful Comment to CONTRIBUTING.md #104
Merged
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
auscompgeek
reviewed
Jan 5, 2024
CONTRIBUTING.md
Outdated
| @@ -20,6 +20,7 @@ Testing: | |||
| * New examples must run! You *must* test your code on either a robot or in | |||
| simulation. If there's something broken in RobotPy, file an issue to get it | |||
| fixed | |||
| * To test a vision file, run `python -m cscore vision.py` in the directory of the vision file | |||
There was a problem hiding this comment.
We should link to the docs instead: https://robotpy.readthedocs.io/en/stable/vision/other.html#vision-other-runcustom
|
Thanks! |
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.
In pull request #100, a comment was made to:
in reference to:
Therefore a line was added to CONTRIBUTING.md to help people test files that they are porting to RobotPy examples!