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

No Contributing Guidelines for the Project #213

Closed
saurabhMayank opened this issue Mar 1, 2022 · 3 comments · Fixed by #367
Closed

No Contributing Guidelines for the Project #213

saurabhMayank opened this issue Mar 1, 2022 · 3 comments · Fixed by #367
Labels
documentation Improvements or additions to documentation

Comments

@saurabhMayank
Copy link

saurabhMayank commented Mar 1, 2022

Please add a CONTRIBUTING.md file mentioning how to contribute to this project.

@jayqi jayqi added the documentation Improvements or additions to documentation label Mar 1, 2022
@ms1596
Copy link

ms1596 commented May 3, 2022

Any movements in this issue ????

@aaossa
Copy link
Contributor

aaossa commented Sep 27, 2022

I've seen that many projects consider issues, bug reports, code contributions and more, as contributions. Considering that, it would be nice to include issue templates and maybe FAQ or common issues pinned somewhere for users. In the other hand, for code contributors some critical parts are:

  • Setting up an environment (using venv)
  • Installing dev/test dependencies
  • Running the test suite (make test)
  • Running linters (make lint)

To go further, it would be nice to have:

  • Pointers to issue/PR labels looking for contributors
  • A PR template with a checklist

I think that the contributing section of the psf/black docs can be a good reference since it already includes some of the described items.

@pjbull
Copy link
Member

pjbull commented Oct 10, 2023

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 a pull request may close this issue.

5 participants