Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve getting started documentation #136

Open
arjendev opened this issue Oct 4, 2024 · 1 comment
Open

Improve getting started documentation #136

arjendev opened this issue Oct 4, 2024 · 1 comment

Comments

@arjendev
Copy link
Collaborator

arjendev commented Oct 4, 2024

No description provided.

@arjendev
Copy link
Collaborator Author

arjendev commented Oct 11, 2024 •
edited
Loading

I don't think the getting started is in a well enough shape to guide a citizen developer and thus I don't want to highlight it in the main README for now. If people have no exposure before to Python, the current getting started does not explain the following topics well enough:

  1. Mention python needs to be installed
  2. Selecting the Python interpreter in vscode
  3. How to write your first test
  4. How to run a test with test explorer / pytest
  5. Should we guide the user through setting up a requirements.txt?
  6. Should we guide the user in setting up a venv?

@arjendev arjendev changed the title Move set up repository, installing and initializing and the getting started into it's own getting started section Improve getting started documentation Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@arjendev