ARCHIVED: Contribute to Rivet

• Create a submission
• Guidelines for creating a GitHub issue
• Submission review

Create a submission

The Rivet team uses issues in github.iu.edu to track new Rivet component submissions, bugs, feedback, and other suggestions related to the design system. To provide context for the kind of contribution you'd like to make, first create a GitHub issue, following the guidelines in the next section.

For more about IU's GitHub service and links to Git and GitHub documentation, see About GitHub at IU.

Guidelines for creating a GitHub issue

When creating a new issue:

1. Go to the Rivet source repository on github.iu.edu.

   If prompted, log in with your IU username and passphrase.

2. Click New Issue.
3. Complete the issue template as best you can. To ensure that your submission can move to the review process, be sure to include:
   • A fairly short, descriptive title
   • Some explanation about what will be gained by adding this design, and what will be lost otherwise
   • A description of the design problem the component solves
   • At least one of the following examples, to demonstrate your concept:
     • Screenshots or images of your rendered design
     • Wireframes
     • Design mock-ups (for example, Axure)
     • Links (for example, Codepen or jsFiddle)
     • An iPhone photo of a napkin sketch

     Your submission doesn't need to be styled or have visual design.

   • Any other documents, links, or research you think will be helpful
   Notes:

   • If you have a specific use case for a proposed solution, provide some context (for example, screenshots, links).
   • If you are a developer and would like help with your submission from a designer, be sure to mention that when creating your issue. Someone from the review team will help pair you up with a designer. This also applies to designers who would appreciate help from a developer.
   • If you're proposing a content change, include a draft of the text content you're focused on.
4. When you're done with the issue template, click Submit new issue.

Submission review

If Rivet staff need more information, the team will contact you to request it, and will mark the issue as "needs more info". If the submission has enough information and supporting material, the team will mark the issue as "Proposed".

The team will do a review of the proposed design based on the following criteria:

• Usability: Is the interaction flow clearly documented? Is the pattern responsive? Does it follow commonly accepted best practices?
• Flexibility: Does the component meet the greatest number of use cases possible? In other words, is this a common pattern that occurs in lots of applications, or it solving a particular problem in one application?
• Accessibility: Is the pattern accessible to all intended audiences?
• Visual design: Is the contribution consistent with our visual style?
• Content: Does the pattern have plain language, correct spelling, and grammar? Does the author clearly describe actions?

If the team decides not to move forward with the submission, the issue will be marked as "archived", with an accompanying explanation.