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

Expand our Contributing guide with more examples and details #498

Closed
nehanene15 opened this issue Jun 3, 2022 · 3 comments · Fixed by #1082
Closed

Expand our Contributing guide with more examples and details #498

nehanene15 opened this issue Jun 3, 2022 · 3 comments · Fixed by #1082
Labels
good first issue Good issue for new DVT contributors priority: p2 Medium priority. Fix may not be included in next release (e.g. minor documentation, cleanup) type: docs

Comments

@nehanene15
Copy link
Collaborator

We should include more examples of how to locally test code before committing, details on conventional commit guidelines when opening a PR and writing commit messages, how to run our linter (black, flake8), and more about nox.

See this Contributing guide as an example.

@nehanene15 nehanene15 added priority: p2 Medium priority. Fix may not be included in next release (e.g. minor documentation, cleanup) good first issue Good issue for new DVT contributors type: docs labels Jun 3, 2022
@nehanene15
Copy link
Collaborator Author

nehanene15 commented Jun 3, 2022

Add how to test with pytest:

pip install pyfakefs==4.3.3
pytest tests/unit

And how to lint:

pip install black==22.3.0
pip install flake8
black $BLACK_PATHS
flake8 $PATHS

As done in our nox tests.

@sourav25998
Copy link

Hello @nehanene15 . I am starting my open source contribution journey and this issue seems to be a good start. Can you please assign this issue to me and brief me about it?

@nehanene15
Copy link
Collaborator Author

Hello @nehanene15 . I am starting my open source contribution journey and this issue seems to be a good start. Can you please assign this issue to me and brief me about it?

Hi, this issue is simply adding documentation for how to contribute to DVT (how to test code, open issues, etc.). Feel free to open a PR with changes if you would like to address this. Issue #596 would also be a good first issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good issue for new DVT contributors priority: p2 Medium priority. Fix may not be included in next release (e.g. minor documentation, cleanup) type: docs
Projects
None yet
2 participants