Skip to content

Commit

Permalink
Changed repo links after transfer repo to grommet (#1144)
Browse files Browse the repository at this point in the history
  • Loading branch information
ShimiSun authored Sep 22, 2020
1 parent 3fed04c commit 6519139
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 35 deletions.
27 changes: 20 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
# Contributing
# Contributing

Thanks for helping us make the HPE Design System better! You came to the right place to start your contribution.

## Project Structure

The HPE Design System is a monorepo built from two modules.
See the [README](https://github.com/hpe-design/design-system#welcome-to-hpe-design-system)
See the [README](https://github.com/grommet/hpe-design-system#welcome-to-hpe-design-system)
for a break down of the Design System structure.

## Submitting Pull Requests
## Submitting Pull Requests

To make a pull request you will need a GitHub account. For help, see
GitHub’s documentation on [forking] and [pull requests].
1. Fork the design-system repository

1. Fork the hpe-design-system repository
2. Clone the repository

```
git clone https://github.com/hpe-design/design-system.git
git clone https://github.com/grommet/hpe-design-system.git
```

3. Install dependencies

```
yarn install
```

4. Implement your changes

### Committing your changes

To commit your changes: `git commit`

Upon running this command, pre-commit checks will run:
Expand All @@ -32,26 +40,31 @@ Upon running this command, pre-commit checks will run:
- End-to-end tests ([TestCafe](https://devexpress.github.io/testcafe/documentation/getting-started/))

#### About TestCafe

TestCafe is tool which assists end-to-end testing (i.e. test behavior and interactions for applications / Websites) across browsers and operating systems. TestCafe executes these tests in live browser instances (as opposed to simulated or headless environments).

NOTE: Things to be aware of while the TestCafe test suites are running.

- TestCafe will launch a browser instance for any browsers you have on your local machine
- Browser windows must be in focus in order for the tests to run. If the browser window is minimized or hidden by other windows, the test will pause and will not complete until the browser is in focus.

Linting and end-to-end tests are run using husky.

#### aries-site

- There are pre-commit hooks in place that will run linting checks and
fixes. It will then run the test suites that we have in place for aries-site.
fixes. It will then run the test suites that we have in place for aries-site.
- [TestCafe](https://devexpress.github.io/testcafe/documentation/getting-started/) is used as our end-to-end testing. While running the tests, your local browsers will open with TestCafe. During this time DO NOT CLOSE OR MINIMIZE YOUR BROWSER WINDOWS. The browser will need to stay in focus in order
to run and complete all of the test suites.
to run and complete all of the test suites.
- The [tests will pause](https://github.com/DevExpress/testcafe/issues/1198) if they are not in focus which will lead to pre-commits taking much longer then needed.
- If your test suites are taking longer than 2.5 minutes, make sure your browser windows are in focus and running.

After the pre-commit checks are finished on aries-site, they will be run on aries-core.

#### aries-core

- The pre-commit checks will run linting checks for aries-core.

### Completed Pre-Commits

Once all of the pre-commit checks are passed, you can add your commit message and push up a PR to be reviewed.
58 changes: 34 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# hpe design-system monorepo
### HPE Design System Site

[![Netlify Status](https://api.netlify.com/api/v1/badges/39e37d4a-4f9f-4946-8aeb-b8328b1821cd/deploy-status)](https://app.netlify.com/sites/keen-mayer-a86c8b/deploys) - https://design-system.hpe.design/

### HPE Design System Site

[![Netlify Status](https://api.netlify.com/api/v1/badges/39e37d4a-4f9f-4946-8aeb-b8328b1821cd/deploy-status)](https://app.netlify.com/sites/keen-mayer-a86c8b/deploys) - https://design-system.hpe.design/

### Storybook

[![Netlify Status](https://api.netlify.com/api/v1/badges/e4cb8d72-f3c0-4490-a4d7-54273ac277ed/deploy-status)](https://app.netlify.com/sites/thirsty-shockley-2b7675/deploys) - http://storybook.hpe.design/

# Welcome to HPE Design System

Aries is a monorepo built from two modules.

1. aries-core
Expand Down Expand Up @@ -59,54 +59,64 @@ Running in production mode:
yarn build
```

## Sprint Schedule
## Sprint Schedule

### Q3

**June 2020**
6/8
- Digest company app page layout variations
- Initial [page layout](https://github.com/hpe-design/design-system/issues/797) design review
- Designer "How to get started" training video

- Digest company app page layout variations
- Initial [page layout](https://github.com/grommet/hpe-design-system/issues/797) design review
- Designer "How to get started" training video

6/15
- Final Page Layout design review

- Final Page Layout design review
- Developer "how to get started" training video
- Grommet Designer Intro tetorial
- Grommet Designer Intro tutorial

6/22
- Add page layouts to the Design System site
- [Card](https://github.com/hpe-design/design-system/issues/801) and [List](https://github.com/hpe-design/design-system/issues/799) template exploration
- Grommet Designer Share tetorial

- Add page layouts to the Design System site
- [Card](https://github.com/grommet/hpe-design-system/issues/801) and [List](https://github.com/grommet/hpe-design-system/issues/799) template exploration
- Grommet Designer Share tetorial

6/29
- Initial Card template design review
- Grommet Designer Backing up tetorial

- Initial Card template design review
- Grommet Designer Backing up tetorial

**July 2020**
7/6
- Fisrt pass Card template review

- Fisrt pass Card template review
- Design System/Brand Central content audit

7/13
- First pass list template review
- Final Card template design review
- Initial Table template design review

- First pass list template review
- Final Card template design review
- Initial Table template design review

7/20

- Final List template review
- Align Design System/Brand Central content
- Align Design System/Brand Central content

7/27

- First pass Table template review
- Initial Data Visualization template design review
- Initial Data Visualization template design review

8/3
- Final Table template review

- Final Table template review

8/10
- First pass Data Visualization review

8/17
- Initial Asynchronous Notifications design review
- First pass Data Visualization review

8/17

- Initial Asynchronous Notifications design review
2 changes: 1 addition & 1 deletion aries-core/tools/release-stable.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import path from 'path';

dotenv.config();

const repoURL = `https://${process.env.GH_TOKEN}@github.com/hpe-design/design-system.git`;
const repoURL = `https://${process.env.GH_TOKEN}@github.com/grommet/hpe-design-system.git`;

const localFolder = path.resolve('.tmp/aries-core');
const localDist = path.resolve('dist');
Expand Down
2 changes: 1 addition & 1 deletion aries-site/src/components/content/SubmitFeedback.js
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export const SubmitFeedback = () => {
<Button label="Leave feedback" onClick={onOpen} primary />
<Button
alignSelf="start"
href={`https://github.com/hpe-design/design-system/tree/master/aries-site/src/pages${router.pathname}.mdx`}
href={`https://github.com/grommet/hpe-design-system/tree/master/aries-site/src/pages${router.pathname}.mdx`}
label="Edit this page"
rel="noopener"
target="_blank"
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
"private": true,
"repository": {
"type": "git",
"url": "git+https://github.com/hpe-design/design-system.git"
"url": "git+https://github.com/grommet/hpe-design-system.git"
},
"bugs": {
"url": "https://github.com/hpe-design/design-system/issues"
"url": "https://github.com/grommet/hpe-design-system/issues"
},
"devDependencies": {
"@hpe/project-scripts": "^1.0.8",
Expand Down

0 comments on commit 6519139

Please sign in to comment.