lion/CONTRIBUTING.md
2019-09-17 11:04:53 +02:00

1.1 KiB

Contributing

Check out ways to contribute to Lion Web Components:

Existing components: we love pull requests ♥

Help out the whole lion community by sending your merge requests and issues. Check out how to set it up:

Setup:

# Clone the repo:
git clone https://github.com/ing-bank/lion.git
cd lion

# Install dependencies
# We require yarn as we use yarn workspaces
yarn install

# Create a branch for your changes
git checkout -b fix/buttonSize

Make sure everything works as expected:

# Linting
npm run lint

# Tests
npm run test

# Storybook Demo
npm run storybook

Create a Pull Request:

# add fork to your remotes
git remote add fork git@github.com:<your-user>/lion.git

# push new branch to your fork
git push -u fork fix/buttonSize
  • Go to your fork and create a Pull Request :)

Some things that will increase the chance that your merge request is accepted: