Skip to content

Contributing

Jump to bottom
Danny edited this page Oct 24, 2019 · 6 revisions

Anyone can propose a new block, component or layout for RDS. However, priority is for the Carleton community.

"System design is about not tackling design problems in isolation, or as one-offs. It’s about considering versatile solutions that can be used repeatedly and consistently throughout a product. It’s about considering versatile solutions that can be used repeatedly and consistently throughout a product. It’s about not creating a different way to solve the same or similar problem every time you come across it." - Laying the Foundation - Andrew Couldwell

For the best success, submissions should follow the proposal template below. You don't need to answer every question. But the expectations are to submit at least one answer per section. Note: you can replace the term block with component or layout to meet your submission.

New block proposal

Block purpose

  • What is the block trying to accomplish?
  • What are the expected user benefits/use cases?

What problem is the block solving

  • What is the problem? Executive summary in a paragraph (tweet).
  • What are the main pain points?
  • What happens if this block does not get created?

Existing blocks

  • Are there existing blocks that are close in functionality or solve a similar problem.
  • Is it possible to solve the issue by extending an existing block? Create a new variant? Is it unique?
  • Have you considered extending or adding features to an existing block

Promote reuse

  • Do you see this block being needed or used on multiple sites? It should have a use case in at least 2 unique web properties.

UX familiarity

  • Does this pattern exist in the wild? Include links to any examples.
  • Do you have links to other sites solving this issue?

Details

  • Proposed block name/handle

If you have them.. attach images or include links to any examples, research or code to support your proposal, if available. A mockup - can be a simple wireframe or full design (based on RDS design guidelines - NEEDED)

Review

The RDS core group reviews proposals in the community backlog to check they meet these criteria. Proposals that meet the criteria will then be marked ‘to do’, ready to be worked on.

Clone this wiki locally