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 proper contribution guide #41

Open
Luc1412 opened this issue Dec 25, 2024 · 0 comments
Open

Add proper contribution guide #41

Luc1412 opened this issue Dec 25, 2024 · 0 comments
Assignees
@trevorflahardy
Labels
feature request This is a feature request.

Comments

@Luc1412
Copy link
Member

Luc1412 commented Dec 25, 2024

Summary

A contribution guide should be added.

The Problem

Currently it's not 100% clear on how to setup a dev environment for pull requests. But it also might not be on how to report issues.

The Ideal Solution

We should mention everything important on how to setup a dev env and then create proper PRs.
This includes:

  • Cloning repo
  • Installing dev requirements (pip install -U .[dev])
  • Installing pre-commit hook (pre-commit install)
  • How to get started with testing.

We might also include some details for proper bug reporting.

The Current Solution

No response

Additional Context

No response
@Luc1412 Luc1412 added the feature request This is a feature request. label Dec 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@trevorflahardy trevorflahardy

Labels
feature request This is a feature request.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Luc1412 @trevorflahardy