-
Notifications
You must be signed in to change notification settings - Fork 69
Add new feature request template #613
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| name: ✨ Feature Request | ||
| description: Suggest a new feature or enhancement for this project | ||
|
|
||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: > | ||
| #### Before submitting a feature request, please search through [existing issues](https://github.com/meta-pytorch/forge/issues?q=is%3Aissue+sort%3Acreated-desc+) to see if something similar has already been proposed. | ||
| - type: textarea | ||
| attributes: | ||
| label: 🎯 Context/Motivation | ||
| description: | | ||
| Describe the problem you're trying to solve or the use case for this feature. | ||
| What is the motivation behind this request? Why would this feature be valuable? | ||
| placeholder: | | ||
| Example: "When training large models, I often need to..." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: 💡 What does this look like in pseudo-code? | ||
|
||
| description: | | ||
| Provide a rough sketch of what the API or implementation might look like. | ||
| This helps us understand your vision for how the feature would work. | ||
| placeholder: | | ||
| ```python | ||
| # Example pseudo-code showing how you envision using this feature | ||
| model = MyModel() | ||
| result = model.new_feature(...) | ||
| ``` | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: ✅ Acceptance Criteria | ||
|
||
| description: | | ||
| What would need to be true for this feature to be considered complete? | ||
| List the key requirements or behaviors expected. | ||
| placeholder: | | ||
| - [ ] The feature should support X | ||
| - [ ] It should handle edge case Y | ||
| - [ ] Documentation is updated | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: 📝 Additional Context | ||
| description: | | ||
| Add any other context, screenshots, examples, or references that would help explain the feature request. | ||
| placeholder: | | ||
| Links to similar implementations, research papers, or other relevant information. | ||
| validations: | ||
| required: false | ||
| - type: markdown | ||
| attributes: | ||
| value: > | ||
| Thanks for contributing 🎉! | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fine to keep as is, but i think it could be a one liner