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.

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

Document development setup #770

Open
tfmorris opened this issue Aug 2, 2023 · 1 comment
Open

Document development setup #770

tfmorris opened this issue Aug 2, 2023 · 1 comment

Comments

@tfmorris
Copy link
Contributor

tfmorris commented Aug 2, 2023

There doesn't appear to be any documentation about how to set up a development environment.

Some of the things I remember having to do:

  • pip install pre-commit
  • python -m pip install -e .
  • pre-commit install
  • if you made any commits before doing the above, pre-commit run --all-files
  • if ruff complains, but doesn't fix anything, either install ruff and run it by hand or temporarily uncomment the --fix argument in the pre-commit config file
@cclauss
Copy link
Contributor

cclauss commented Aug 2, 2023

That would make a great pull request.

Also, some suggestions around creating a venv especially since new OSes like Debian Bookworm require a venv.

I use pipx to install cli tools like black, ruff, etc. so that they are always ready to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants