Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Latest commit

 

History

History
56 lines (39 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.21 KB
Raw

Thanks for contributing to react-column-select!

Setup

  1. Fork the repo (click the Fork button at the top right of this page)
  2. Clone your fork locally:
git clone https://github.com/<your_github_username>/react-column-select.git
cd react-column-select

Development

  • Storybook for rapid UI component development and testing

Commands

yarn build: run build for the react-column-select package.

yarn test: run test for the react-column-select package.

yarn lint: run prettier to lint the package code.

Making a Pull Request?

Clearly state what changes you have made and wether they are breaking changes in the PR description.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features
  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)
  • refactor: any code related change that is not a fix nor a feature
  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)
  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies
  • test: all changes regarding tests (adding new tests or changing existing ones)
  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)
  • chore: all changes to the repository that do not fit into any of the above categories

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

License

By contributing your code to the react-column-select GitHub repository, you agree to license your contribution under the MIT license.