docs: add Getting Started section to README for Python/Poetry setup and quick run commands#2
Open
kaddujames501-ship-it wants to merge 2 commits into
Open
Conversation
…nd quick run commands
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a concise 'Getting Started' section to README.md outlining Python/Poetry prerequisites, environment setup, and example flan commands to streamline new user onboarding before the detailed Usage section. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider making it explicit that the
flancommands in step 3 should be run either insidepoetry shellor prefixed withpoetry run(e.g.,poetry run flan ...) to avoid confusion for users unfamiliar with Poetry-managed environments. - It might help to mention where the user should expect
path/to/your_sample.vcf.gzto come from (e.g., sample data in the repo or their own VCF) so newcomers know how to obtain or prepare this file for the quick workflow.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider making it explicit that the `flan` commands in step 3 should be run either inside `poetry shell` or prefixed with `poetry run` (e.g., `poetry run flan ...`) to avoid confusion for users unfamiliar with Poetry-managed environments.
- It might help to mention where the user should expect `path/to/your_sample.vcf.gz` to come from (e.g., sample data in the repo or their own VCF) so newcomers know how to obtain or prepare this file for the quick workflow.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
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.
Added a "Getting Started" section to the README.md to guide new users through initial setup and a basic workflow.
This includes verifying Python 3.9+ and Poetry installation, running poetry install, and executing sample commands like flan global fit and flan global predict.
The update reduces onboarding friction by providing clear, actionable steps before the detailed Usage section.
Summary by Sourcery
Add an introductory Getting Started section to the README to guide new users through basic Python/Poetry setup and a simple local workflow.
Documentation: