Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 2.32 KB
Raw

Contributing

Before moving ahead with making contributions please make sure that you have read the code of conduct mentioned in the CODE_OF_CONDUCT.md file.

Prerequisites

Make sure you have node.js and git installed on your machine.
If you haven't then this article will help you in installation of git and this article will help in istallation of node.js

Setting up project locally

  1. Fork this repository by clicking on the fork button on the top of this page, this will create a copy of this repository in your account.
  2. Clone your forked version by entering git clone "https://github.com/YOUR_GITHUB_UserName/react-widgets.git"
  3. Change the directory from present to the project directory by entering cd react-widgets/
  4. Install all dependencies by entering npm i
  5. Run the project locally by entering npm start
    This will run the project locally on port localhost:3000 in your default browser.

Branching

  1. Open a new window of your terminal and change the directory into the project folder
  2. Now create a new branch using git checkout -b <add-your-new-branch-name>
    For example git checkout-b vishal-codes
  3. Now make the required changes in the project which will resolve or add a feature as per mentioned in the respective issue.

Commiting changes

  1. Add the changes to the branch you just created using the git add . command
  2. Now commit those changes using git commit -m <"a short description about changes u made">
    For example git commit -m "Added new language in translator"
  3. Push the changes using git push origin <add-your-branch-name>
    For example git push origin vishal-codes
  4. Submit your changes for review by creating a pull request, if you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.
  5. Soon I'll be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.

Where to go from here?

Congrats! You just completed the standard fork -> clone -> branch -> edit -> PR workflow that you'll encounter often as a contributor!