Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

84 lines (55 loc) · 2.29 KB
Raw

Contributing Guidelines

Wicara is open source, so every component in Wicara is developed by your help. You too can help contribute to this project! This page describes how to setup the project on your computer for local development.

This project is bound by a Code of Conduct.

The Five Golden Rules

The simple steps of contributing to any GitHub project are as follows:

  1. Fork the repository
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push -u origin my-new-feature
  5. Create a Pull Request!

To keep your fork of in sync with this repository, follow this guide.

For members of the Kata.ai organisation, or if you have push access to this repository, just clone directly from the repo and push your branches here. It's fine.

Prerequisites

Windows, macOS and Linux

Prerequisite Check

Run these commands inside the Terminal (PowerShell/Command Prompt for Windows).

Git: You should see the version number:

$ git version
git version 2.18.0

Node.js: You should see the version number:

$ node -v
v8.11.4

Yarn: You should see the version number:

$ yarn -v
1.9.4

Setting Up

First, you should clone the repository.

$ git clone https://github.com/kata-ai/wicara.git

After these repository has been cloned, cd into the repository:

$ cd wicara

Install the project's dependencies. Note that we use Yarn, not npm:

$ yarn

Developing

To start developing components, you have to run the Storybook server.

$ yarn storybook
info Storybook started on => http://localhost:9001/

The storybook server is available at http://localhost:9001. Note that any new component needs to have at least one story as a demo, and some tests.