CONTRIBUTING.md

Contributing

Check out ways to contribute to Lion Web Components:

Feature requests

When you have an idea on how we could improve, please check our closed issues to see if there are similar ideas. If there are none, please submit your feature request as an issue. Add a clear description of what you expect from the improvement and what the use case is. The issue will be closed and the community can add 👍 reactions to vote and show interest. When the feature gets picked up, the issue can be reopened.

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:

• At https://github.com/ing-bank/lion click on fork (at the right top)

# 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:

• Write tests.
• Write a good commit message.