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

[pyOpenSci review] Improve onboarding of new contributors by additional info in CONTRIBUTING.md #534

Closed
rich-iannone opened this issue Dec 2, 2024 · 0 comments · Fixed by #550

Comments

@rich-iannone
Copy link
Member

From the pyOpenSci comment:

suggestion (CONTRIBUTING.md): I believe we can ease the onboarding of new contributors and reduce the burden of maintenance by adding a little more content to this file.
Namely, we can explicitly list the requirements for a submission to be considered (e.g. code style, formatting, having tests covering the new feature/preventing a regression on a bug fix) and the make command associated. In addition, we can also include the command to create a virtual environment with the development dependencies and guide new contributors to using pre-commit.

pyOpenSci/software-submission#202 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant