Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.99 KB

Contributing to Fortune-JS

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Table of Contents

Setting Up the project locally

To install the project you need to have node and yarn (can be replaced by NPM).

  1. Fork the project, clone your fork:

    # Clone your fork
git clone https://github.com/<your-username>/fortune-js.git

# Navigate to the newly cloned directory
cd fortune-js

  2. After that, install all the necessary dependencies and have fun:

    yarn install
# or
npm install

  3. Oh yeah, just remembered. Install husky. He, as a faithful dog, will ensure that you commit only a good code 🐶:

    yarn husky install

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/StLyn4/fortune-js.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Submitting a Pull Request

Before the commit, the Linter will automatically check your files. If you want to check them up to Commit, then use the yarn run lint [--fix] command.