[DOC] Add a Contributing Guide #102
Open
+203
−0
Conversation
This file contains 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
nv-rliu
added
doc
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
rlratzel
approved these changes
Mar 26, 2025
|
|
||
| --> | ||
|
|
||
| ### Summary of pre-commit hooks |
There was a problem hiding this comment.
I don't have a strong opinion, but it might be better in the long run to just mention the yaml file that contains the checks (which you did) and remove the more detailed descriptions of each check, since it seems likely to go stale. I think the most important things contributors should know was already mentioned: how to install and run pre-check, and where the list of checks are.
There was a problem hiding this comment.
I like that idea. Less things to maintain is good. Pushed the change.
Co-authored-by: Rick Ratzel <3039903+rlratzel@users.noreply.github.com>
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.
Closes #103
Proposed Change
Adds a
CONTRIBUTING.mdfile to the repo. This should cover opening issues, contributing to the project, setting up development environments, pre-commit hooks, and RAPIDS conventions.