Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
115 lines (79 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

115 lines (79 loc) · 4.04 KB

Thanks for showing interest to contribute to Blockchain UI!

When it comes to open source, there are different ways you can contribute, all of which are valuable. Here's a few guidelines that should help you as you prepare your contribution.

Setup the Project

The following steps will get you up and running to contribute to Blockchain UI:

  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/Blockchain-UI-Org/Library.git
cd blockchain-ui
  1. Setup all the dependencies and packages by running yarn install. This command will install dependencies.

If you run into any issues during this step, kindly reach out to the Blockchain UI React team here: contact@blockchain-ui.com

Tooling

  • Storybook for rapid UI component development and testing
  • Testing Library for testing components and hooks
  • Changeset for changes documentation, changelog generation, and release management.

Commands

yarn install: bootstraps the entire project, symlinks all dependencies for cross-component development and builds all components.

yarn storybook: starts storybook server and loads stories in files that end with .stories.tsx.

yarn build: run build for all component packages.

yarn test: run test for all component packages.

yarn release: publish changed packages.

Think you found a bug?

Please create an issue or email contact@blockchain-ui.com

Proposing new or changed API?

Please provide thoughtful comments and some sample API code. Proposals that don't line up with our roadmap or don't have a thoughtful explanation will be closed.

Making a Pull Request?

Pull requests need only the 👍 of two or more collaborators to be merged; when the PR author is a collaborator, that counts as one.

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.

Steps to PR

  1. Fork of the blockchain-ui repository and clone your fork

  2. Create a new branch out of the dev branch. We follow the convention [type/scope]. For example fix/accordion-hook or docs/menu-typo. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.

  3. Make and commit your changes following the commit convention.

  4. git push

Tests

All commits that fix bugs or add features need a test.

License

By contributing your code to the blockchain-ui GitHub repository, you agree to license your contribution under the MIT license.