Skip to content

Commit 9d7bbd6

Browse files
Merge branch 'develop' into dev
2 parents d8a5a7a + 9cff0c6 commit 9d7bbd6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+10772
-7864
lines changed

.editorconfig

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ root = true
22

33
[*]
44
charset = utf-8
5-
indent_style = space
5+
indent_style = tab
6+
indent_size = 4
67
trim_trailing_whitespace = false
78
end_of_line = lf
89
insert_final_newline = true

.github/CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to Pattern Lab Shared Front End
2+
If you'd like to contribute to the shared frontend for Pattern Lab Node and PHP, please do so! There is always a lot of ground to cover and something for your wheelhouse.
3+
4+
## Developing Locally
5+
6+
The best way to make changes to this repo and test them is through your existing edition.
7+
8+
### Node
9+
10+
* Fork this repository on Github.
11+
* Create a new branch in your fork and push your changes in that fork.
12+
* `npm install`
13+
* `npm link`
14+
* `cd /path/to/your/edition`
15+
* `npm link @pattern-lab/styleguidekit-assets-default`
16+
17+
### PHP
18+
19+
Once you've installed the requirements do the following to set-up for development:
20+
21+
1. `cd /path/to/dev-edition/packages/pattern-lab/styleguidekit-assets-default`
22+
2. `git config branch.dev.remote origin`
23+
3. `npm install`
24+
4. `bower install`
25+
26+
## Making Changes
27+
28+
To make changes **always edit files in `src/`**. To make sure that these changes are reflected in the front-end and `dist/` folder run the following:
29+
30+
gulp --copy-dist=../../../public
31+
32+
To watch for changes you can use:
33+
34+
gulp --watch --copy-dist=../../../public
35+
36+
At this point changes to the static assets should compile to the correct locations in the project as well as `dist/`.
37+
38+
## Guidelines
39+
40+
* 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
41+
* _USUALLY_ submit pull requests against the [develop branch](https://github.com/pattern-lab/styleguidekit-assets-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`
42+
* Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
43+
* Commits should reference the issue you are adressing.
44+
* 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.
45+
46+
## Coding style
47+
48+
* The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/).
49+

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ node_modules/*
22
src/bower_components/*
33
.sass-cache/*
44
.DS_Store
5+
/.eslintignore

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
1-
![license](https://img.shields.io/github/license/pattern-lab/styleguidekit-assets-default.svg)
1+
![license](https://img.shields.io/github/license/pattern-lab/styleguidekit-assets-default.svg) ![current release](https://img.shields.io/github/release/pattern-lab/styleguidekit-assets-default.svg)
22
[![Packagist](https://img.shields.io/packagist/v/pattern-lab/styleguidekit-assets-default.svg)](https://packagist.org/packages/pattern-lab/styleguidekit-assets-default) [![Gitter](https://img.shields.io/gitter/room/pattern-lab/frontend-viewer.svg)](https://gitter.im/pattern-lab/frontend-viewer)
33

44
# Static Assets for the Default StyleguideKit
55

6-
These static assets are meant to be used with the default [Mustache](https://github.com/pattern-lab/styleguidekit-mustache-default) and [Twig](https://github.com/pattern-lab/styleguidekit-twig-default) StyleguideKits. They control the look, feel, and functionality of the front-end of Pattern Lab PHP.
6+
This code is responsible for creating Pattern Lab's UI look, feel, and functionality. These assets are are meant to be used in conjunction with the default [Mustache](https://github.com/pattern-lab/styleguidekit-mustache-default) and [Twig](https://github.com/pattern-lab/styleguidekit-twig-default) StyleguideKits, which control Pattern Lab-specific UI _inside_ the iframe.
77

88
## Installation
99

10+
### Node
11+
Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To install the default static assets run:
12+
13+
npm install styleguidekit-assets-default
14+
15+
16+
### PHP
17+
1018
Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project dependencies. To install the default static assets run:
1119

1220
composer require pattern-lab/styleguidekit-assets-default
@@ -15,28 +23,11 @@ Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project depe
1523

1624
In order to modify these assets you need to install the following:
1725

18-
* the [Development Edition of Pattern Lab PHP](https://github.com/pattern-lab/edition-php-development)
26+
* the [Development Edition of Pattern Lab](https://github.com/pattern-lab/edition-php-development)
1927
* [Node.js](http://nodejs.org) and NPM
2028
* [Bower](http://bower.io)
2129
* [Ruby Sass](http://sass-lang.com/install)
2230

2331
## Development Set-up
2432

25-
Once you've installed the requirements do the following to set-up for development:
26-
27-
1. `cd /path/to/dev-edition/packages/pattern-lab/styleguidekit-assets-default`
28-
2. `git config branch.dev.remote origin`
29-
3. `npm install`
30-
4. `bower install`
31-
32-
## Making Changes
33-
34-
To make changes **always edit files in `src/`**. To make sure that these changes are reflected in the front-end and `dist/` folder run the following:
35-
36-
gulp --copy-dist=../../../public
37-
38-
To watch for changes you can use:
39-
40-
gulp --watch --copy-dist=../../../public
41-
42-
At this point changes to the static assets should compile to the correct locations in the project as well as `dist/`.
33+
Read the [contribution guidelines](https://github.com/pattern-lab/styleguidekit-assets-default/blob/master/.github/CONTRIBUTING.md)

bower.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"license": "MIT",
99
"private": true,
1010
"dependencies": {
11-
"classlist": "~2014.7.23",
1211
"jquery": "~2.1.1",
1312
"jwerty": "~0.3.2",
1413
"prism": "gh-pages",

0 commit comments

Comments
 (0)