Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 2.31 KB

Contributing Guidelines

First off, thank you for considering contributing to this project!

Table of contents

I Have a Question

See our support guidelines. Do not use GitHub issues for general support or questions.

I Want to Contribute

Legal Notice

You will need to agree to our CLA in order to be possible to consider your contribution.

Starting Guide

By following the steps bellow you will understand the development process and worflow.

  1. Forking the repository
  2. Installing Node and Yarn
  3. Installing dependencies
  4. Running the tests
  5. Submitting a pull request

Forking the repository

The first step would be to fork the repository. This will allow you to get a current copy of the repository state. Follow the steps to also clone your forked repository locally.

All new branches should be created from main. PRs would be requested to main branch. An approval from a team member is required before merging.

Installing Node and Yarn

The Safe React Hooks uses Node as development environment and Yarn to manage the dependencies. You will need to make sure you are using the latest Node LTS version and that you have available Yarn v1.

You can check which versions you are using with:

node -v
yarn -v

Installing dependencies

Install all dependencies and build the whole project by using the following commands at the project root.

yarn install
yarn build

Running the tests

yarn test

Submitting a pull request

From the forked repository you can open a pull request to the original repository. Make sure to select the safe-global:development branch as the target branch.