Skip to content
This repository has been archived by the owner on Aug 26, 2021. It is now read-only.

Commit

Permalink
Renamed uikit -> design-system-components
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam A. Zerella committed Jan 9, 2019
1 parent e3f31dd commit be5f983
Show file tree
Hide file tree
Showing 97 changed files with 236 additions and 236 deletions.
2 changes: 1 addition & 1 deletion .deploy/manifest-production.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
applications:
- name: uikit
- name: design-system-components
buildpack: nginx_buildpack
memory: 64M
instances: 2
Expand Down
2 changes: 1 addition & 1 deletion .deploy/manifest-staging.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
applications:
- name: uikit
- name: design-system-components
buildpack: nginx_buildpack
memory: 64M
instances: 1
Expand Down
2 changes: 1 addition & 1 deletion .deploy/manifest-testing.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
applications:
- name: uikit
- name: design-system-components
buildpack: nginx_buildpack
memory: 64M
instances: 1
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/----bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ about: " If something isn't working as expected"

# Bug Report

- [ ] I’ve read and understood the [Contributing guidelines](https://github.com/govau/uikit/blob/master/CONTRIBUTING.md) and have done my best effort to follow them.
- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/uikit/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve read and understood the [Contributing guidelines](https://github.com/govau/design-system-components/blob/master/CONTRIBUTING.md) and have done my best effort to follow them.
- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/design-system-components/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve searched for any related issues and avoided creating a duplicate issue.

## What happened
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/---feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ about: "Suggest an idea for the product"
---

# Feature Request
- [ ] I’ve read and understood the [Contributing guidelines](https://github.com/govau/uikit/blob/master/CONTRIBUTING.md) and have done my best effort to follow them.
- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/uikit/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve read and understood the [Contributing guidelines](https://github.com/govau/design-system-components/blob/master/CONTRIBUTING.md) and have done my best effort to follow them.
- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/design-system-components/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve searched for any related issues and avoided creating a duplicate issue.
- [ ] I've searched the [community forums](https://community.digital.gov.au/c/designsystem) to check for related issues or feature requests

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---support-question.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ about: "If you need support using the design system (the community is here to he

# Support question

- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/uikit/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve read and agree to the [Code of Conduct](https://github.com/govau/design-system-components/blob/master/CODE_OF_CONDUCT.md).
- [ ] I’ve searched for any related issues/questions on github
- [ ] I've searched the [community forums](https://community.digital.gov.au/c/designsystem) to check for related issues or support questions

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/--join-the-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are several ways you can contribute:

1. Participate in the discussions on the [community forums](https://community.digital.gov.au/c/designsystem)

2. Donate developer time on the [open issues](https://github.com/govau/uikit/issues)
2. Donate developer time on the [open issues](https://github.com/govau/design-system-components/issues)

3. Identify any bugs or improvements and create an issue

Expand Down
4 changes: 2 additions & 2 deletions .templates/index/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">

<title>All UI-Kit modules</title>
<title>Design System Modules</title>

<script type="text/javascript">
var $html=document.documentElement;if($html.classList)$html.classList.remove("no-js"),$html.classList.add("js");else{var className="no-js";$html.className=$html.className.replace(new RegExp("(^|\\b)"+className.split(" ").join("|")+"(\\b|$)","gi")," "),$html.className+=" js"}
Expand Down Expand Up @@ -142,7 +142,7 @@
<p role="alert">This website needs JavaScript to work properly.</p>
</noscript>

<h1>All UI-Kit module tests</h1>
<h1>All components module tests</h1>

<main>
<ol class="module-list">
Expand Down
2 changes: 1 addition & 1 deletion .templates/new-module/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@gov.au/[-replace-name-] CHANGELOG
======================

> Part of the [gov.au UI-Kit](https://github.com/govau/uikit/) ecosystem.
> Part of the [gov.au components](https://github.com/govau/design-system-components/) ecosystem.

## Contents
Expand Down
2 changes: 1 addition & 1 deletion .templates/new-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The visual test: [-replace-URL-]
## License

Copyright (c) Commonwealth of Australia.
Licensed under [MIT](https://raw.githubusercontent.com/govau/uikit/packages/core/master/LICENSE).
Licensed under [MIT](https://raw.githubusercontent.com/govau/design-system-components/packages/core/master/LICENSE).


**[⬆ back to top](#contents)**
Expand Down
4 changes: 2 additions & 2 deletions .templates/new-module/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@
},
"repository": {
"type": "git",
"url": "https://github.com/govau/uikit.git"
"url": "https://github.com/govau/design-system-components.git"
},
"homepage": "https://designsystem.gov.au/components/[-replace-name-]",
"bugs": {
"url": "https://github.com/govau/uikit/issues",
"url": "https://github.com/govau/design-system-components/issues",
"email": "[email protected]"
},
"author": {
Expand Down
6 changes: 3 additions & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## 1. Purpose

A primary goal of the UI-Kit is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are
A primary goal of the components is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are
committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status,
and religion (or lack thereof).

This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.

We invite all those who participate in the UI-Kit to help us create safe and positive experiences for everyone.
We invite all those who participate in the components to help us create safe and positive experiences for everyone.

## 2. Open Source Citizenship

Expand Down Expand Up @@ -68,7 +68,7 @@ unacceptable behavior feel safe. In the context of in-person events, organizers

## 7. Addressing Grievances

If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the UI-Kit team with a concise description of your
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the components team with a concise description of your
grievance. Your grievance will be handled in accordance with our existing governing policies.

## 8. Scope
Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Contributing to UI-Kit
Contributing to GOV.AU Design System Components
======================

Hi there! Thank you for your interest in contributing to UI-Kit, we really appreciate it.
Hi there! Thank you for your interest in contributing to these components, we really appreciate it.

There are many ways to contribute – reporting bugs, fixing bugs, new module suggestions, submitting pull requests for enhancements to modules or even writing
documentation.
Expand All @@ -23,7 +23,7 @@ Wherever you are, and whatever your discipline is, you are invited to contribute
* [Tested](#tested)
* [Considered](#considered)
* [Reporting Bugs, Sending Suggestions](#reporting-bugs-asking-questions-sending-suggestions)
* [Installing UI-Kit locally](#installing-ui-kit-locally)
* [Installing components locally](#installing-components-locally)


-------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -58,7 +58,7 @@ Before new components and patterns are published into the design system, the tea
| [Usable](#usable) | It’s been tested and shown to work with a representative sample of users, including those with disabilities. |
| [Consistent](#consistent) | It uses existing styles and components in the design system where relevant. |
| [Versatile](#versatile) | It can be easily applied in different contexts. |
| [Coded](#coded) | Components are ready to merge in the UI-Kit |
| [Coded](#coded) | Components are ready to merge in |
| [Tested](#tested) | It’s been tested and shown to work with a range of browsers, assistive technologies and devices. |
| [Considered](#considered) | Documentation and rationale have been provided. |

Expand Down Expand Up @@ -125,15 +125,15 @@ For example, what happens with a navigation component that has more items than d

**Code is for humans.** Please look at the coding style and work with it, not against it. We write comments, add spacing, and prefer readable code over clever code. Yes, code is actually for computers, but it is humans that need to maintain it.

**Code comments.** Code should be commented so that it is as usable as possible. Try to provide reasoning or links to documentation about any peculiar decisions that had to be made. [For example.](https://github.com/govau/uikit/blob/master/packages/body/src/sass/_module.scss#L127)
**Code comments.** Code should be commented so that it is as usable as possible. Try to provide reasoning or links to documentation about any peculiar decisions that had to be made. [For example.](https://github.com/govau/design-system-components/blob/master/packages/body/src/sass/_module.scss#L127)

**Follow the folder structure.** New components should follow the same folder structure as the [existing components.](https://github.com/govau/uikit/tree/master/.templates/new-module)
**Follow the folder structure.** New components should follow the same folder structure as the [existing components.](https://github.com/govau/design-system-components/tree/master/.templates/new-module)

**CSS** can be dependent on other components, but must use core functions and mixins at a minimum.

* For spacing, padding, or other metrics like border-width, use [AU-space()](https://github.com/govau/uikit/blob/master/packages/core/src/sass/_globals.scss#L475)
* For font-sizes and line-height, use [AU-fontgrid()](https://github.com/govau/uikit/blob/master/packages/core/src/sass/_globals.scss#L629)
* For colours, use the [core colour variables](https://github.com/govau/uikit/blob/master/packages/core/src/sass/_globals.scss#L741)
* For spacing, padding, or other metrics like border-width, use [AU-space()](https://github.com/govau/design-system-components/blob/master/packages/core/src/sass/_globals.scss#L475)
* For font-sizes and line-height, use [AU-fontgrid()](https://github.com/govau/design-system-components/blob/master/packages/core/src/sass/_globals.scss#L629)
* For colours, use the [core colour variables](https://github.com/govau/design-system-components/blob/master/packages/core/src/sass/_globals.scss#L741)

**JavaScript.** The Design System supports **JavaScript, JQuery, and React.** To make integration easier any JavaScript supplied for a component should be written in at least one of these.

Expand All @@ -145,7 +145,7 @@ For example, what happens with a navigation component that has more items than d

**Accessibility.** A component on its own must be accessible to [WCAG 2.1 level AA.](https://www.w3.org/TR/WCAG21/) Some documentation on how this has been checked, tested, or decisions made to support accessibility should be supplied.

**Browser and device tested.** All components should meet our [browser support requirements.](https://github.com/govau/uikit#browser-support)
**Browser and device tested.** All components should meet our [browser support requirements.](https://github.com/govau/design-system-components#browser-support)

**No JavaScript fallbacks.** All components must degrade _gracefully_ when JavaScript is disabled. We expect that a user can still complete their task without JavaScript enabled, it just might not be beautiful. For example, accordions default to ‘open’ when JavaScript is disabled so that users can still use the content.

Expand All @@ -167,7 +167,7 @@ Provide rationale; the more the better. We aim to explain design and code decisi

## Reporting Bugs, Asking Questions, Sending Suggestions

Use the search in [issues](https://github.com/govau/uikit/issues) to see if the same bug, question or suggestion has already been raised.
Use the search in [issues](https://github.com/govau/design-system-components/issues) to see if the same bug, question or suggestion has already been raised.

If you’re requesting a new module, prefix the title with `new module: `.

Expand All @@ -180,11 +180,11 @@ happened instead. For more info look at our [issue template](./ISSUE_TEMPLATE.md
-------------------------------------------------------------------------------------------------


## Installing UI-Kit locally
## Installing components locally

If you’d like to contribute code, first, you will need to run UI-Kit locally.
If you’d like to contribute code, first, you will need to run the components locally.

💡 Building the UI-Kit is only necessary if you want to contribute to it. If you want to use the modules in your own project, install them via npm as described
💡 Building the components is only necessary if you want to contribute to it. If you want to use the modules in your own project, install them via npm as described
in [How to use](./README.md#how-to-use).

To build this project you have to install [lerna](https://github.com/lerna/lerna) globally after cloning it via `npm install -g lerna` and run:
Expand Down
Loading

0 comments on commit be5f983

Please sign in to comment.