Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.82 KB

System Requirements

Software version
NodeJS >= 12.0.0
Firefox Browser >= 80

Extension Workflow

save-hash-codeflow

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]/save-hash.git save-hash
  1. Set up the upstream remote URL for referencing the original repository
git remote add upstream https://github.com/rahuldahal/save-hash
  1. from the noteit directory, install necessary dependencies
cd save-hash
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 flash-message-setup
  1. Start the web-ext module
npm start

This will open a new firefox window and reload the extension whenever a change is made.

  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 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.
    • click on that big green button.