Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.6 KB
Raw

Warning

February 2024: The contribution criteria and process are currently being redeveloped. An updated backlog will be published soon. If you have questions about how you can contribute to the design system, email [email protected].

How you can contribute

The B.C. Design System needs a strong community behind it to make it successful. You can contribute by reporting bugs, editing documentation, participating in discussions, or even creating new components. Your contribution to it will ensure it helps meets user needs from across the BC government.

Discussing styles and components

You can discuss the existing styles and components in the Design System, or ones being developed, by commenting on issues in the component and design pattern backlog. Alternatively, you can email [email protected].

For example, you can:

  • ask questions about a style or component
  • answer questions from other contributors
  • share examples or demos of a component
  • share research relating to a style or component

Propose a new component or pattern

Anyone can propose a new component or pattern for the BC Design System. To be successful, proposals need to show that the component or pattern being suggested would be useful and unique.

Follow these 2 steps to propose a component or pattern for the Design System.

1. Check the backlog

Check if the team has already included the idea in the backlog, or if someone else has already suggested the same idea or something similar.

2. Raise an issue

If your idea is not on the backlog, raise an issue using the Propose a New Component template.

Editing content

If you believe the content on the design system could be written more clearly, raise an issue using the Content Edit Request template.

Reporting Bugs

If you find a bug on the design system, raise an issue using the Component Bug Report template

All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the license under which this project is distributed.

Content has been modified from the GOV.UK Design System “How you can contribute” page