Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.44 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Installation

git clone git@github.com:magicsoup-io/stock.git
npm install
npm start

You can now view your style guide in the browser:

  Local:            http://localhost:6060/
  On your network:  http://192.168.1.2:6060/

Scripts

  • npm start starts the styleguidist development server
  • npm run styleguide makes a static build of the styleguide
  • npm run build creates a production ready build of the component library
  • npm test runs all tests