You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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/).
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.
7
7
8
8
## Installation
9
9
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
+
10
18
Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project dependencies. To install the default static assets run:
0 commit comments