Skip to content

Commit

Permalink
Create feature_request.md
Browse files Browse the repository at this point in the history
  • Loading branch information
methanet authored Jun 28, 2024
1 parent 304bb6c commit 747430b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: feature request
about: suggested feature
title: ''
labels: feature request
assignees: ''
---

For feature proposals that require additional research, include:
* Proposal and background.
* Motivation of why the feature is interesting from reserach perspective and why it will be useful for the users.
* Short outline of experiments, and description of necessary sub components (e.g. data curation, training, evaluation), if needed.
* Related literature or list of references that may be useful in evaluating the reserach proposal.

We will use github issues to the discuss the proposal. Based on our discussions, the contributor(s) will proceed to implement the feature and will provide guidance/help, as needed.
Once we receive the PRs, we will review them and merge them after we perform necessary verificaiton and fixing any bugs.

0 comments on commit 747430b

Please sign in to comment.