hypothesis / hypothesis/cookiecutters

Document the development environment

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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](https://hypothes-is.slack.com/archives/C4K6M7P5E/p1658933812209189)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.