Skip to content

Latest commit

 

History

History
79 lines (54 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 1.88 KB

Setup on your local machine

Make sure you have NodeJS and Netlify CLI installed

Dependency Version
NodeJS ~10.x.x
Netlify-CLI ~2.x.x

  1. Fork this repository, click on the fork icon located on top-right side of this page, below your avatar

  2. Clone that forked repository.

git clone https://github.com/[yourUsername]/football-stats.git football-stats
  1. Set up the upstream remote URL for referencing the original repository
git remote add upstream https://github.com/rahuldahal/football-stats
  1. from the football-stats directory, install necessary dependencies
cd football-stats
npm install

The generic workflow

  1. Pull the latest changes from the original repository (the upstream)
git pull upstream master
  1. Then, create a branch for every new feature/bug fix
git checkout -b [branchName] # eg. git checkout -b teamInfo-feature
  1. Start the server
npm run dev # on http://localhost:3000

This will start the netlify server (locally), and webpack (within express via webpack-dev-middleware)

  1. Do your change / Implement a new feature
  2. Don't forget to keep pushing your progress to the remote (your forked repository)
git add .
git commit -m "brief about your change..."
git push -u origin [branchName]

message me if you have any problem

Getting ready to send a Pull Request

  1. Make sure all the tests pass.
npm test # should pass all the checks
  1. Create a pull request,
    • Go to your forked repository on github,
    • If there are no conflicts, you will see a button saying create a new Pull Request.
    • click on that big green button.