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

Add contributor documentation #66

Open
iainelder opened this issue Mar 16, 2023 · 0 comments
Open

Add contributor documentation #66

iainelder opened this issue Mar 16, 2023 · 0 comments

Comments

@iainelder
Copy link
Collaborator

There was a bit of back-and-forth on last week's PR #64 because the README lacks a "developer" or "contributor" quick start guide.

We should write and link to the standard CONTRIBUTING file format that covers at least the following:

  • How to set up the development environment (Install Poetry and what else?)
  • How to install the project (poetry install)
  • How to run the tests (pre-commit)
  • What to include in the PR (e.g. no changelog required)
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
@iainelder