-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* rewriting and updating repo documentation * rewriting and updating repo documentation * content edits * edits to readme * content edits * add warning note to contribution documentation * rewriting and updating repo documentation * content edits * edits to readme * content edits * add warning note to contribution documentation * edit legacy docs section * update callout * remove redundant link
- Loading branch information
1 parent
c165ea5
commit bb38fa6
Showing
4 changed files
with
38 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe | |
|
|
||
| ## Enforcement | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at angelika.ehlers@gov.bc.ca. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:designsystem@gov.bc.ca). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
|
||
| Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| > [!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 BC 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. | ||
| 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](https://github.com/bcgov/design-system/projects/1). Alternatively, you can email <[email protected]>. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,53 @@ | ||
| # BC Government Design System [](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) | ||
| # B.C. Design System [](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) | ||
|
|
||
| The Design System helps developers and designers build better digital products and services. | ||
| > [!NOTE] | ||
| > **February 2024**: The B.C. Design System is currently in active development. If you have questions, [contact the design system team](#contact) or [open an issue](https://github.com/bcgov/design-system/issues). | ||
| It’s a collection of digital resources and tools – including a library of reusable UI/interface components and design patterns. The system makes it easier and faster to build custom B.C. government websites and applications. | ||
| The B.C. Design System will give design and software development teams the building blocks to deliver intuitive, accessible digital services. | ||
|
|
||
| Components are collectively built by the government community, meet accessibility standards and are open for input and improvement. | ||
| The B.C. Design System will comprise 4 core elements: | ||
|
|
||
| ## Documentation | ||
| * [Design tokens](#bc-design-tokens) (currently in beta) | ||
| * React component library (in development) | ||
| * Design library in Figma (in development) | ||
| * Documentation hub (in development) | ||
|
|
||
| https://developer.gov.bc.ca/Design-System/About-the-Design-System | ||
| The new design system will replace [the legacy design system](#legacy-documentation). Legacy component and documentation will be deprecated and archived. | ||
|
|
||
| ## Files in this repository | ||
| ## B.C. Design Tokens | ||
|
|
||
| ``` | ||
| docs/ - Project Documentation | ||
| └── images | ||
| └── icons | ||
| The [B.C. Design Tokens package](https://github.com/bcgov/design-system/tree/docs/packages/design-tokens) is the first release as part of the new design system. | ||
|
|
||
| openshift/ - OpenShift-specific files | ||
| ├── scripts - helper scripts | ||
| └── templates - application templates | ||
| ``` | ||
| Design tokens provide a method to quickly and consistently implement the province's look and feel for digital services. They offer a set of standardized options to help developers style user interfaces in a consistent and future-proof way. | ||
|
|
||
| ## Deployment (Local Development) | ||
| * [Installable package on npm](https://www.npmjs.com/package/@bcgov/design-tokens) | ||
| * [Source code](https://github.com/bcgov/design-system/tree/master/packages/design-tokens) | ||
| * [Figma library](https://www.figma.com/community/file/1326994583954765832) | ||
|
|
||
| * Developer Workstation Requirements/Setup | ||
| * Application Specific Setup | ||
| ## Component library | ||
|
|
||
| ## Deployment (OpenShift) | ||
| The component library will provide an inventory of reusable UI components, including: | ||
|
|
||
| See (openshift/Readme.md) | ||
| * Components in Figma | ||
| * Reference implementations in React | ||
| * Support for other languages and frameworks is currently out-of-scope. | ||
|
|
||
| ## Getting Help or Reporting an Issue | ||
| The component library is currently in active development. | ||
|
|
||
| To report bugs/issues/feature requests, please file an [issue](https://github.com/BCDevOps/opendev-template/issues/). | ||
| A [proof-of-concept/preview](https://www.npmjs.com/package/@bcgov/design-system-react-components) of the React library is published on npm. | ||
|
|
||
| ## How to Propose a Component | ||
| ## Contact | ||
|
|
||
| If you would like to propose a component to the design system, please see our [Propose a Component](.github/ISSUE_TEMPLATE/propose-a-new-component.md) guideline. | ||
| The B.C. Design System is maintained by Government Digital Experience (GDX), a division of the Ministry of Citizens' Services. You can contact the design system team by email at [[email protected]](mailto:[email protected]), or [open an issue](https://github.com/bcgov/design-system/issues/new/choose). | ||
|
|
||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). | ||
| By participating in this project you agree to abide by its terms. | ||
| ## Legacy documentation | ||
| > [!WARNING] | ||
| > The previous B.C. government design system is not actively supported. These resources are provided for reference only. These resources will be officially deprecated and archived after the new BCDS component library is released. | ||
| Documentation and components for the legacy design system are accessible in this repo and on DevHub: | ||
|
|
||
| * [Developer documentation](https://developer.gov.bc.ca/Design-System/About-the-Design-System) | ||
| * [Source code](https://github.com/bcgov/design-system/tree/master/components) | ||
|
|
||
| ## License | ||
|
|
||
|
|
||