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

Create Pull Request Template #92

Open
robertkossendey opened this issue Mar 7, 2023 · 5 comments
Open

Create Pull Request Template #92

robertkossendey opened this issue Mar 7, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@robertkossendey
Copy link
Collaborator

We should create a template for pull requests, requiring the contributor to tick a box stating that he read the contributing guidelines (CONTRIBUTING.md). By that we can make sure that the contributor has run the pre-commit hooks on his machine (flake8, black and pytest).

@robertkossendey robertkossendey added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 7, 2023
@MrPowers
Copy link
Owner

MrPowers commented Mar 8, 2023

Yes, I like this idea, thank you for making this suggestion. Would be great for someone to grab this.

@robertkossendey
Copy link
Collaborator Author

@MrPowers we should also add an Issue Template with "I would like to contribute" checks as well. More and more people are opening issues / contributing, so this will come in handy.

@MrPowers
Copy link
Owner

@robertkossendey - yea, an issue template with "I would like to contribute" would be great as well. Good idea!

@Triamus
Copy link
Contributor

Triamus commented Mar 17, 2023

Would be great if pure documentation commits don't require pre-commit setup as it may scare off folks who otherwise have valuable contributions. Can you exclude changes to the README.md from pre-commit hooks requirement by default somehow?

@paulooctavio
Copy link

paulooctavio commented May 14, 2024

@robertkossendey Can I take this one? It will be my first issue, so I might just need a little guidance.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants