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 issue template for better orientation #466

Merged
merged 1 commit into from Oct 4, 2022

Conversation

SimonFrings
Copy link
Member

@SimonFrings SimonFrings commented Sep 6, 2022

This pull request adds issue templates to this project.

grafik

With GitHub Discussions now activated on an organizational level (as discussed in #460), it makes sense to add issue templates to each ReactPHP repository to show users where they have to open up specific tickets:

  • New feature ideas and questions belong in ReactPHP discussions. GitHub discussions are more long-lived than issues, thus enabling better visibility for users.
  • We'll continue to use issues for bug reports. These bugs will be fixed at some point and then belong in closed issues. Additionally I won't add a bug template to reactphp/reactphp. IMO it makes no sense to report a bug in this repository. All bugs should be reported inside the related repo (http, socket, dns, etc.).
  • Security issues should be reported to us via email. It is important not to make security-related issues public before they have been fixed!

I will file pull requests to add issue templates for each ReactPHP repository. Repos like https://github.com/reactphp/branding or https://github.com/reactphp/.github won't receive them (makes no sense).

@nhedger
Copy link
Contributor

nhedger commented Sep 8, 2022

I believe it's possible to create default issue templates at the organization level.

This should save you from having to open PR on all repositories.

@SimonFrings
Copy link
Member Author

@nhedger You're totally right, the only thing I'd have to do is to add the ISSUE_TEMPLATE folder to the .github folder inside reactphp/.github and it's done.

The downside is that EVERY project inside the ReactPHP organisation gets the same issue template. This may make sense for most projects (like dns, http, etc.) but not for something like reactphp/branding or reactphp/reactphp. I would instantly do this if GitHub had some kind of functionality to exclude specific repositories, but I didn't find anything similar.

In conclusion: I am willing to take the slightly longer road and do it for every repository individually (which means only to copy-paste at some point 😄). Just feels right ^^

@SimonFrings
Copy link
Member Author

@clue, @WyriHaximus I had to rebase my chnages to match #462, now all tests are green and this is ready for review.

Copy link
Member

@WyriHaximus WyriHaximus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

@clue clue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SimonFrings Thank you for the update, changes LGTM! :shipit:

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

Successfully merging this pull request may close these issues.

None yet

4 participants