CONTRIBUTING.md

Contributing

Getting Started

First, create a fork of the Polydile/dile-components repository by hitting the fork button on the GitHub page.

Next, clone our repository onto your computer.

git clone [git@github.com:Polydile/dile-components.git]

Once cloning is complete, change directory to the repository.

cd dile-components

Now add your fork as a remote (replacing YOUR_USERNAME with your GitHub username).

git remote add fork git@github.com:<YOUR_USERNAME>/dile-components.git

Create a new local branch.

git checkout -b my-awesome-fix

Preparing Your Local Environment for Development

Now that you have cloned the repository, you need to install the dependencies.

npm install

This will download and install all packages needed.

This is a monorepo managed by Lerna, so you need to link the local packages with lerna bootstrap.

npm run lerna bootstrap

To launch the demos run this command:

npm run start

Making Your Changes

Make your changes to the project. Make something great!

Committing Your Changes

Commit messages must follow the conventional commit format So for example if you fix a terrible bug in the package @dile/dile-input, the commit message should look like this:

fix(dile-input): fix terrible bug

Create a Pull Request

Now it's time to push your branch that contains your committed changes to your fork.

git push -u fork my-awesome-fix

After a successful push, if you visit your fork on GitHub, you should see a button that will allow you to create a Pull Request from your forked branch, to our main branch.