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

Add documentation for how to set up project locally #18

Open
4 tasks
njallskarp opened this issue Jun 27, 2023 · 0 comments
Open
4 tasks

Add documentation for how to set up project locally #18

njallskarp opened this issue Jun 27, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@njallskarp
Copy link
Owner

Documentation

We need to document how to set up the project locally with all the configuration

  • linter so it matches github actions.
  • Instructions on how to run linter such that if linting passes locally then it will pass on github
  • Instructions on how to run test suites
  • Instructions on how to set up poetry and install deps
@njallskarp njallskarp added the documentation Improvements or additions to documentation label Jun 27, 2023
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

2 participants