Conversation
|
|
||
| We try to keep Github issues for bug reports and feature requests only. If | ||
| you have a question, please ask it on Stack Overflow or in one of the channels | ||
| mentioned at https://www.doctrine-project.org/community/index.html |
There was a problem hiding this comment.
ORM can keep its own template for this, that hints at github discussions instead.
There was a problem hiding this comment.
ORM, for example, has Support Questions in GitHub Discussions. I don't know if those should be also enabled in other repositories, but it looks like those won't be configured with a markdown template afaik.
There was a problem hiding this comment.
We should mention the GitHub Discussions board on the linked page though.
There was a problem hiding this comment.
@derrabus Other repositories don't have Discussions enabled. Are we going to enable them in every repository and mention them in this template, or do you suggest this for the ORM template?
There was a problem hiding this comment.
I think @derrabus means to link to the ORM Github Discussions from the community page.
There was a problem hiding this comment.
I'll mention that you can configure issue templates and add your own types that link to an external resource, rather than opening the Github issue form. In the MongoDB extension config we specifcally use this to link to the community forums.
There was a problem hiding this comment.
@alcaeus that's really good to know given that I'm stating that we should not use github issues for support, and then the community page I links back to Github… could be confusing! I'll try something similar to what you did.
|
|
||
| <!-- | ||
| Provide a failing Unit or Functional Test - you can submit one in a Pull | ||
| Request separately, referencing this bug report. | ||
| If that is too difficult, provide a link to a minimal repository containing an | ||
| application that reproduces the bug. | ||
| If the bug is simple, you may provide a code snippet instead, or even a list of | ||
| steps. | ||
| --> |
There was a problem hiding this comment.
A full pull request with a fix would be welcome too. Some people still might not know that they can already provide a fix for a bug that they found in Doctrine code and just need a nudge into that direction.
There was a problem hiding this comment.
I've added a short sentence to add that nudge. What do you think?
There was a problem hiding this comment.
Is this rather for non-technical description of a new feature? Otherwise I would also suggest something like an expected behaviour on how the creator of the feature request believes how this feature could be implemented.
There was a problem hiding this comment.
I've reused a template we use in my company, with 3 sections:
- Why
- What
- How
All 3 sections have comments asking for something.
Does that work for you?
|
|
||
| We try to keep Github issues for bug reports and feature requests only. If | ||
| you have a question, please ask it on Stack Overflow or in one of the channels | ||
| mentioned at https://www.doctrine-project.org/community/index.html |
There was a problem hiding this comment.
We should mention the GitHub Discussions board on the linked page though.
| #### Why | ||
|
|
||
| <!-- | ||
| Explain why you believe this feature should be implemented. | ||
| --> | ||
|
|
||
| #### What | ||
|
|
||
| <!-- | ||
| Describe the behavior you would like to see. | ||
| --> |
There was a problem hiding this comment.
I suggest flipping the what and why; often the "why" becomes quite apparent when describing the suggested feature. I'm also blindly assuming that most such requests come from "I want to use feature X that isn't supported" thoughts, rather than "I have problem X that needs to be solved by a new feature". In that case, the thought process would always lead someone to a "what" before going on to the "why".
| #### Why | |
| <!-- | |
| Explain why you believe this feature should be implemented. | |
| --> | |
| #### What | |
| <!-- | |
| Describe the behavior you would like to see. | |
| --> | |
| #### What | |
| <!-- | |
| Describe the behavior you would like to see. | |
| --> | |
| #### Why | |
| <!-- | |
| Explain why you believe this feature should be implemented. | |
| --> |
|
|
||
| We try to keep Github issues for bug reports and feature requests only. If | ||
| you have a question, please ask it on Stack Overflow or in one of the channels | ||
| mentioned at https://www.doctrine-project.org/community/index.html |
There was a problem hiding this comment.
I'll mention that you can configure issue templates and add your own types that link to an external resource, rather than opening the Github issue form. In the MongoDB extension config we specifcally use this to link to the community forums.
We also have PR templates at least in ORM, but I do not think they are used at all, since you have to add a `?template=the_template.md` parameter to enable them.
We also have PR templates at least in ORM, but I do not think they are used at all, since you have to add a
?template=the_template.mdparameter to enable them.