Simplify contributing info #255
Merged
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
…plify_contributing_info
|
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.
The current instructions for setting up the full development environment are rather complex because of the use of poetry and having to install and test against multiple python versions in various virtual environments. For small contributions, including those from student projects for example, a simpler approach using
pip install -e .is actually sufficient.This pull request adds a simplified development setup to the contributing guide and separates the instructions on how to setup the full development environment in a separate file in the documentation.
The main idea is that in this way, it will be more inviting for first time contributors to make small changes to Kernel Tuner.