Skip to content

Commit b7ee1b4

Browse files
committed
fix(CONTRIBUTING): Update contribution guidelines
1 parent 9ec911e commit b7ee1b4

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

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

+4-13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
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.
1+
# 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.
33

44
## Developing Locally
55

@@ -12,16 +12,7 @@ The best way to make changes to this repo and test them is through your existing
1212
* `npm install`
1313
* `npm link`
1414
* `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`
15+
* `npm link @pattern-lab/uikit-default`
2516

2617
## Making Changes
2718

@@ -38,7 +29,7 @@ At this point changes to the static assets should compile to the correct locatio
3829
## Guidelines
3930

4031
* 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`
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`
4233
* Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
4334
* Commits should reference the issue you are adressing.
4435
* 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.

0 commit comments

Comments
 (0)