From ac83d982886379b827a5d491b3d72436c0eefd36 Mon Sep 17 00:00:00 2001 From: Brian Muenzenmeyer Date: Sat, 10 Mar 2018 16:17:00 -0600 Subject: [PATCH] fix(README): update content for consistency part of #815 --- packages/uikit-workshop/.github/CONTRIBUTING.md | 8 ++++---- packages/uikit-workshop/README.md | 10 ++++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/packages/uikit-workshop/.github/CONTRIBUTING.md b/packages/uikit-workshop/.github/CONTRIBUTING.md index 9a2024008..d6ab592b8 100644 --- a/packages/uikit-workshop/.github/CONTRIBUTING.md +++ b/packages/uikit-workshop/.github/CONTRIBUTING.md @@ -1,5 +1,6 @@ # Contributing to the Default Pattern Lab Front End -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. + +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. ## Developing Locally @@ -12,7 +13,7 @@ The best way to make changes to this repo and test them is through your existing * `npm install` * `npm link` * `cd /path/to/your/edition` -* `npm link @pattern-lab/uikit-default` +* `npm link @pattern-lab/uikit-workshop` ## Making Changes @@ -29,7 +30,7 @@ At this point changes to the static assets should compile to the correct locatio ## Guidelines * 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 -* _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` +* _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` * Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier. * Commits should reference the issue you are adressing. * 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. @@ -37,4 +38,3 @@ At this point changes to the static assets should compile to the correct locatio ## Coding style * The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/). - diff --git a/packages/uikit-workshop/README.md b/packages/uikit-workshop/README.md index 723c7a4ad..fc9a35ed1 100644 --- a/packages/uikit-workshop/README.md +++ b/packages/uikit-workshop/README.md @@ -1,5 +1,6 @@ -![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) -[![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) +![license](https://img.shields.io/github/license/pattern-lab/patternlab-node.svg) +![current release](https://img.shields.io/npm/v/@pattern-lab/uikit-workshop.svg) +[![Gitter](https://img.shields.io/gitter/room/pattern-lab/frontend-viewer.svg)](https://gitter.im/pattern-lab/frontend-viewer) # UIKit Default @@ -10,6 +11,7 @@ This code is responsible for creating Pattern Lab's default workshop UI look, fe ## Installation ### Node + Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To install the default static assets run: npm install @pattern-lab/uikit-default @@ -21,7 +23,7 @@ In order to modify these assets you need to install the following: * [Node.js](http://nodejs.org) and NPM * [Bower](http://bower.io) * [Ruby Sass](http://sass-lang.com/install) - + ## Development Set-up -Read the [contribution guidelines](https://github.com/pattern-lab/uikit-default/blob/master/.github/CONTRIBUTING.md) +Read the [contribution guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/packages/uikit-workshop/.github/CONTRIBUTING.md)