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

Document the development environment #68

Open
10 tasks
seanh opened this issue Sep 21, 2022 · 0 comments
Open
10 tasks

Document the development environment #68

seanh opened this issue Sep 21, 2022 · 0 comments

Comments

@seanh
Copy link
Contributor

seanh commented Sep 21, 2022

It would be good to have some high-level documentation of the Hypothesis local development environment: what are the major components? Why and how do we use each? How does it all fit together?

Once this is done we should add a task to the Development environment section of the onboarding task list for the engineer to read the development environment docs. We can't add this task currently because we don't have any docs.

Things to cover:

  • make
  • pyenv
  • tox
  • Maybe explain briefly what Python virtualenvs are?
  • Docker Compose
  • Cookiecutter
  • Possibly Supervisor
  • Maybe briefly explain GitHub Actions workflows?
  • Dependabot?
  • Requirements files and compiling them

Slack thread
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
@seanh