Skip to content

Commit ac83d98

Browse files
committed
fix(README): update content for consistency
part of pattern-lab#815
1 parent 1396a77 commit ac83d98

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

packages/uikit-workshop/.github/CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Contributing to the Default Pattern Lab Front End
2-
If you'd like to contribute to the default frontend for Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
2+
3+
If you'd like to contribute to the default front end for Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
34

45
## Developing Locally
56

@@ -12,7 +13,7 @@ The best way to make changes to this repo and test them is through your existing
1213
* `npm install`
1314
* `npm link`
1415
* `cd /path/to/your/edition`
15-
* `npm link @pattern-lab/uikit-default`
16+
* `npm link @pattern-lab/uikit-workshop`
1617

1718
## Making Changes
1819

@@ -29,12 +30,11 @@ At this point changes to the static assets should compile to the correct locatio
2930
## Guidelines
3031

3132
* Pattern Lab uses a standard [git flow model](http://nvie.com/posts/a-successful-git-branching-model/) unless otherwise noted in a repository. The `develop` branch is not considered stable. Tags and releases are cut from the `master` branch
32-
* _USUALLY_ submit pull requests against the [develop branch](https://github.com/pattern-lab/uikit-default/tree/dev). If you have a major feature to stabilize over time, open an issue about making a dedicated `feature-branch` off of `develop`
33+
* _USUALLY_ submit pull requests against the [develop branch](https://github.com/pattern-lab/uikit-workshop/tree/dev). If you have a major feature to stabilize over time, open an issue about making a dedicated `feature-branch` off of `develop`
3334
* Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
3435
* Commits should reference the issue you are adressing.
3536
* Large enhancements should begin with opening an issue. This will result in a more systematic way for us to review your contribution and determine if a [specifcation discussion](https://github.com/pattern-lab/the-spec/issues) needs to occur.
3637

3738
## Coding style
3839

3940
* The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/).
40-

packages/uikit-workshop/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
![license](https://img.shields.io/github/license/pattern-lab/uikit-default.svg) ![current release](https://img.shields.io/npm/v/@pattern-lab/uikit-default.svg)
2-
[![Packagist](https://img.shields.io/packagist/v/pattern-lab/uikit-default.svg)](https://packagist.org/packages/pattern-lab/uikit-default) [![Gitter](https://img.shields.io/gitter/room/pattern-lab/frontend-viewer.svg)](https://gitter.im/pattern-lab/frontend-viewer)
1+
![license](https://img.shields.io/github/license/pattern-lab/patternlab-node.svg)
2+
![current release](https://img.shields.io/npm/v/@pattern-lab/uikit-workshop.svg)
3+
[![Gitter](https://img.shields.io/gitter/room/pattern-lab/frontend-viewer.svg)](https://gitter.im/pattern-lab/frontend-viewer)
34

45
# UIKit Default
56

@@ -10,6 +11,7 @@ This code is responsible for creating Pattern Lab's default workshop UI look, fe
1011
## Installation
1112

1213
### Node
14+
1315
Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To install the default static assets run:
1416

1517
npm install @pattern-lab/uikit-default
@@ -21,7 +23,7 @@ In order to modify these assets you need to install the following:
2123
* [Node.js](http://nodejs.org) and NPM
2224
* [Bower](http://bower.io)
2325
* [Ruby Sass](http://sass-lang.com/install)
24-
26+
2527
## Development Set-up
2628

27-
Read the [contribution guidelines](https://github.com/pattern-lab/uikit-default/blob/master/.github/CONTRIBUTING.md)
29+
Read the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/packages/uikit-workshop/.github/CONTRIBUTING.md)

0 commit comments

Comments
 (0)