CONTRIBUTING.md

Contributing

• Development Setup
• Tests
• Storybook
• Commits
• Pull Requests

Development Setup

You will need Node.js version 12+

1. Fork from GitHub
2. Clone the forked project
3. checkout develop branch
4. Run npm install to install dependencies.

Tests

To test the component, we are using Cypress. If you add a new feature make sure to write additional tests for it.

Run npm run cypress:open to start the cypress testing server.
The cypress test environment will open itself automatically.

Storybook

We also set up Storybook for our component.

Run npm run storybook to start the storybook server.

Commits

Commit messages should follow Vue's commit message convention.

Pull Requests

• Do not submit PRs against the main branch. Checkout a topic branch from the relevant branch (e.g. develop) and merge back against that branch
• Work in the src folder and DO NOT check in dist in the commits
• It's okay to have multiple small commits - GitHub will automatically squash it before merging
• Make sure the tests pass and the project can be built using npm run build
• Add a test case for new features
• If you are fixing a bug:
  • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your Pull Request title.
  • Add appropriate test coverage if applicable