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

Add some issue/PR templates #159

Open
bollwyvl opened this issue Mar 29, 2021 · 0 comments
Open

Add some issue/PR templates #159

bollwyvl opened this issue Mar 29, 2021 · 0 comments
Labels
task:documentation Improvements or additions to documentation

Comments

@bollwyvl
Copy link
Contributor

bollwyvl commented Mar 29, 2021

We should probably add some PR and issue templates.

For PRs:

  • basically a checklist of:
    • did you open an issue first if it's a big change?
    • does this fix an issue?
    • did you target the dev branch Start a dev branch #154?
    • did you lint/build?
    • did you update the changelog?
    • did you add docs/example?
      • did you test?

For bug reports:

  • we pretty much need to know the exact YAML someone is (at least) calling the action with, otherwise it's really hard to help
  • at least the OS they are running
    • if it's a private (or on a self-hosted runner), they probably need a public demonstrator, or at least redacted logs of the output

For feature requests:

  • whether it's just a feature demand, or whether they are going to PR
  • how it can be tested

For documentation requests:

  • some kind of guidelines, and some brown m&m's that they read the existing docs
@bollwyvl bollwyvl added the task:documentation Improvements or additions to documentation label Mar 29, 2021
@bollwyvl bollwyvl changed the title Add some issue templates Add some issue/PR templates Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant