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

Troubleshoot + Update README developer documentation #127

Open
katiestahl opened this issue Nov 5, 2024 · 0 comments
Open

Troubleshoot + Update README developer documentation #127

katiestahl opened this issue Nov 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@katiestahl
Copy link
Collaborator

I was following the instructions in the readme to update the data and schemas for #126 , but I kept running into issues. It would be nice to have other developers also test out the readme instructions to find any potential issues and add troubleshooting or explicitly clear instructions for development setup to the readme.

We should include the following information in the readme developer documentation:

  • detailed setup instructions (ie; should they have a venv running before doing anything? should they be able to run pip install -e . with no issues? should they run that command or make install? etc.)
  • prerequisites (ie; should poetry be installed already? should we add a requirements file or make command to do this for them?)
  • cloning instructions (this may seem a bit overkill, but since the project dependencies are managed by poetry, which expects specific package and directory names, we should make it clear that the developer should not have a custom local name for the project)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant