Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 2.28 KB
Raw

How to contribute

Hello 👋. We are glad to have you here.


First Steps

  • Fork the repository feminist-bible-phase-2 -Go to the project directory by typing $ cd feminist-bible-phase-2
    - Clone the repository by typing $ git clone https://github.com/username/feminist-bible-phase-2.git in your terminal. Make sure you replace username with your username.
  • Go to the project directory by typing $ cd feminist-bible-phase-2
  • Create a new branch for your modifications (ie. git branch contribution-guide and check it out git checkout contribution-guide) The name of the branch should signify what you are working on (ie creating a contribution guide -> contribution-guide)
  • Make changes as per requirement
  • Add your files (git add -A), commit (git commit -m "addedfile") and push (git push origin new-user)
  • Create a pull request
  • Wait for Pull Request to merge
    With this, you will have all the code available on your local machine. With this, you will have all the code available on your local machine.

For Front End

Got to frontend directory by typing $ cd frontend in your terminal. In the frontend directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.


Contributing to repository

✔ For the first few weeks into the program, the issues will be raised by the project-leads only. Every issue will be assigned to the participants of GSSoC 2020 Extended working on this project.

✔ Kindly refrain from claiming the issues labelled as frontend, as these issues will be assigned to the participants by the project leads, and is NOT based on the first-come-first-served basis. This is done so that everyone gets a fair chance to contribute.

✔ Participant are requested to give regular updates regarding their progress to the project leads.

✔ If the participant is not able to contribute to the assigned issue due to any reason, kindly let the project leads know so that the issue is assigned to some other participant.

Happy Coding 👩‍💻👩‍💻