-
Notifications
You must be signed in to change notification settings - Fork 4
Feature requests
We track, discuss, and prioritize Rivet feature requests using GitHub Discussions.
To see all open feature requests, head over to the Rivet feature and enhancement request discussion page.
Please do not open issues for feature or enhancement requests — issues are reserved for bug reports only.
Before you submit a feature request, take a look through the list of open feature request discussions to see if someone else has already requested a similar feature.
If someone else has already requested a new feature similar to yours, make relevant comments and add your 👍 reaction. Use a reaction in place of a "+1" comment. The add reaction button — a smiley face — is on the individual discussion page itself, near the bottom left of the box containing the first post in the thread.
If you cannot find an existing discussion that describes your requested feature, start one using the guidelines below.
Duplicate feature requests will be locked with a reference to the relevant discussion thread.
If you're new to GitHub Discussions, here's how you can submit a feature request:
- Head over to the feature and enhancement request discussion page by clicking the Discussions tab near the top of the page
- Click the New discussion button near the top of the page to be taken to the new discussion page
- Select 💡 Feature and enhancement requests from the list of categories
Provide as much information as you're able about your requested feature and its use case. Screenshots, Figma mockups, example code, and the like are greatly appreciated.
The more information we have, the better able we are to determine if a feature is a good candidate for a future release. Be sure to address our five evaluation criteria listed below.
Please create a separate discussion for each feature you're requesting, rather than requesting several features in a single thread.
## Summary
Add a clear and concise description of the problem you are trying to solve with this new feature. For example:
> I have the following use case, but there's nothing in Rivet to support it [...]
## Describe the solution you'd like
Add a clear and specific description of what you'd like to see enhanced in or added to Rivet.
## Describe alternatives you've considered
Add a clear and concise description of any alternative solutions or features you've considered.
## Similar features or implementations
Add links to any other sites or design systems that implement a feature similar to the one you're requesting.
## Additional context
Add any other context or screenshots about the feature request here. You might also provide a link to a CodePen or GitHub gist with a proposed implementation.
We evaluate each feature request (and their implementations) according to five criteria below:
- Usefulness. Is the feature potentially useful to the whole Rivet community, or just a specific use case?
- Usability. Does the feature adhere to usability best practices? Are any interactions documented? Is the feature usable at all screen sizes?
- Accessibility. Is the feature accessible to all audiences, regardless of ability? Does the feature meet WCAG guidelines?
- Visual design. Is the feature's design consistent with Rivet's visual style and IU's brand guidelines?
- Documentation. Is the feature well-documented in plain language understandable by developers of all skill levels?
After you submit your feature request, a member of the Rivet team will respond in the thread with follow-up questions and comments.
Our capacity to develop new features each release cycle is limited, and oftentimes new features with the potential to add value wind up being difficult to prioritize.
However, if you've put together an implementation of a feature request in our backlog, we welcome pull requests — this can be a great way to get new features into Rivet without having to wait for us to develop it ourselves.
If you'd like to contribute a new feature to Rivet, check out our guidelines for opening pull requests.
If you're not affiliated with Indiana University, you'll also need to sign a Contributor License Agreement.