feat: improve dev doc #972
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
Member
jiashenC
commented
Aug 27, 2023
•
jiashenC
commented
- Remove duplicate debugging section.
- Fix how to submit PR and testing.
- Reorganize the contribution section.
- Add an installation guide under getting started.
xzdandy
reviewed
Aug 27, 2023
docs/source/contribute/index.rst
Outdated
| python3 -m venv test_evadb_venv | ||
| source test_evadb_venv/bin/activate | ||
| pip install --upgrade pip | ||
| pip install -e ".[dev]" |
There was a problem hiding this comment.
There are extra dependency besides [dev]. Shall we summarize them? Maybe we should have that information on the installation page and refer it here, since it will be helpful for users not only developers.
There was a problem hiding this comment.
Sure. That is a good idea.
There was a problem hiding this comment.
I think the installation page is no longer used. What would be a good place to show this information?
There was a problem hiding this comment.
I think we should add one.
xzdandy
approved these changes
Aug 27, 2023
xzdandy
approved these changes
Aug 28, 2023
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.