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 contributing to README #15

Merged
merged 2 commits into from
Nov 2, 2022
Merged

Add contributing to README #15

merged 2 commits into from
Nov 2, 2022

Conversation

kaitj
Copy link
Collaborator

@kaitj kaitj commented Nov 2, 2022

Proposed changes

This PR adds instructions on setting up the development environment and how to contribute. Additionally, the pre-commit has been updated to better match the quality task that is setup (with the exception of snakefmt).

Types of changes

What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionalitiy)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through the poe quality task
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes

All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

This updates the pre-commit tasks to mostly match is used in the poetry
quality task (minus snakefmt).
Add instructions to the README with development environment setup
instructions.
@kaitj kaitj merged commit 04fe1c3 into main Nov 2, 2022
@kaitj kaitj deleted the readme-update branch November 2, 2022 22:14
@kaitj kaitj added the documentation Improvements or additions to documentation label Nov 30, 2022
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

Successfully merging this pull request may close these issues.

2 participants