-
-
Notifications
You must be signed in to change notification settings - Fork 953
Open
Description
I've noticed there are few areas in the Setup section of CONTRIBUTING.md
that could be clarified or updated to become more beginner-friendly, especially those new to Poetry or Textual. Here are the suggested improvements:
- Poetry Installation Link Redirecting to the instructions
- The current link in the first step to install poetry takes users to Poetry's homepage rather than the installation instructions
- Suggestions: Update it brings users directly to the instructions page of the website
poetry shell
command needs prerequisites installed
- Running the
poetry shell
command assumes users have the packages installed for the command to work, which may not be true to beginners - Suggestion: Another command that doesn't require these installations but still opens the virtual environment is
poetry env activate
- Clarify
textual --version
requirespoetry run
- Newcomers to the project might miss that they need the
poetry run
prefix command - Suggestion: Add
poetry run
to thetextual --version
command
- Adding how to Run examples
- After setup, beginners might wonder how to test an example script
- Suggestion: Include another step which explains to use the
poetry run python <SCRIPT_NAME.py>
to execute an example in the examples folder
Metadata
Metadata
Assignees
Labels
No labels