Add GitHub issue templates (Bug Report, Feature Request, Description)#147
Add GitHub issue templates (Bug Report, Feature Request, Description)#147abhi-14gyan wants to merge 1 commit intom-lab:mainfrom
Conversation
|
Same comment as the other pull request. We never discussed this. We ought to discuss what we want to achieve here, why adding this is a net improvement, as opposed to just more stuff to maintain. I think this is the right direction, but I'd like to hear more about your motivation and why you structured the diff as such. What should we achieve by adding this? Why did you choose such templates specifically? |
|
Also, can you maybe make sure that you review and re-read the titles of the PR(s) you submit? |
|
Thank you for the feedback - completely fair point, and I apologize for jumping ahead without discussion. I'm fairly new to open-source contribution and I'm still learning the proper workflow. Let me share my reasoning here so we can align before I make any further changes. What problem do issue templates solve? Right now, when someone opens an issue on this repo, they get a blank text box. This means:
Structured templates shift that effort to the contributor upfront, so issues arrive in a consistent, actionable format. Why these three templates specifically? I chose Bug Report, Feature Request, and Description (general/question) because they cover the three most common types of issues in most projects, and I didn't want to add anything beyond what's useful:
Why I structured the diff this way:
Why this is a net improvement over maintenance cost: The templates themselves are low-maintenance - they're static YAML files that only need updating when the project structure changes (e.g., if a new top-level component is added). The time saved on triaging well-structured issues should far outweigh the occasional template update. That said, I'm very open to feedback on:
Happy to iterate based on your guidance! |
|
After listing our project for GSoC, we received a large amount of pull requests across several repositories. We are dealing with the backlog, but this would take time. We will get back to this pull request eventually. In the meanwhile, if you are a GSoC applicant, please read our updated GSoC policy: https://github.com/m-lab/gsoc/. |
What
Adds structured GitHub issue templates using YAML issue forms, so the "New Issue" page presents contributors with 3 clear options instead of a blank editor.
Why
The repository currently has no issue templates, which leads to:
Changes
Templates added
bugenhancementquestionConfiguration
Component dropdown options
All templates include a dropdown to identify the affected component:
library/)prototype/)data/)analysis/)docs/)How to test
main