Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

35 lines (19 loc) · 1.41 KB

Contributing to react-floodgate

Welcome! As a contributor to this project, it is expected that you abide by the Code of Conduct.

Setup

This project uses Yarn as its package manager; it is highly recommended that contributors use Yarn if possible.

  1. Fork and clone the repo
  2. Run yarn to install dependencies
  3. Create a branch for your PR

Creating a branch

When creating a branch, please adhere to the following branch name specification:

{username}/{branch_name}

Where:

  • {username}: your Github username
  • {branch_name}: desdcriptive branch name in camelCase

This makes it clear 1. who is making the PR and 2. what problem is being solved/feature being added/etc when reviewing PRs on Github.

Creating a Pull Request

After you have forked the repo and created a feature branch, you can submit a pull request directly to this repo.

Yarn scripts

Any yarn/npm scripts run locally-installed CLI binaries, so there is no worry about making sure your global binaries of the tools used are up to date. Note, this project primarily uses yarn, which is recommended, so ensuring Yarn is properly installed and up-to-date is important in the development process.