Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 2.26 KB
Raw

Contributing to Pattern Lab Shared Front End

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.

Developing Locally

The best way to make changes to this repo and test them is through your existing edition.

Node

  • Fork this repository on Github.
  • Create a new branch in your fork and push your changes in that fork.
  • npm install
  • npm link
  • cd /path/to/your/edition
  • npm link @pattern-lab/styleguidekit-assets-default

PHP

Once you've installed the requirements do the following to set-up for development:

  1. cd /path/to/dev-edition/packages/pattern-lab/styleguidekit-assets-default
  2. git config branch.dev.remote origin
  3. npm install
  4. bower install

Making Changes

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:

gulp --copy-dist=../../../public

To watch for changes you can use:

gulp --watch --copy-dist=../../../public

At this point changes to the static assets should compile to the correct locations in the project as well as dist/.

Guidelines

  • Pattern Lab uses a standard git flow 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. 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 needs to occur.

Coding style

  • The .editorconfig controls spaces / tabs within supported editors. Check out their site.