Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 1.92 KB
Raw

Setup on your local machine

  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]/noteit.git noteit
  1. Set up the upstream remote URL for referencing the original repository
git remote add upstream https://github.com/mynoteit/noteit
  1. from the noteit directory, install necessary dependencies
cd noteit
npm install # installs both frontend and backend dependencies

The generic workflow

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

This will start the mongodb server (locally), express server and webpack (with webpack-dev-server)

  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]

we recommend you to follow conventional commits instructions for writing commit messages.

message me if you have any problem

Getting ready to send a Pull Request

  1. Make sure all the test passes.
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.
    • Make sure to select the develop branch as your pull request target.
    • Click on that big green button.