Skip to content

Latest commit

 

History

History
124 lines (71 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

124 lines (71 loc) · 3.01 KB

Contributing

🔨 Setup & Run

1.) Fork The Repo

Click on Fork button present on the upper-right area of the screen to create a copy of this repository to your GitHub account. fork

2.) Clone The Repo

-> You can clone this branch to your machine by using the below command.

git clone -b development https://github.com/<YOUR_USERNAME>/commclassroom.git

-> Navigate to your repo

cd commclassroom

-> Install dependencies

npm install

3.) Setup Remote

git remote add upstream https://github.com/commclassroom/commclassroom.git

To verify

git remote -v

You will get output similar to this

origin  https://github.com/<YOUR_USERNAME>/commclassroom.git (fetch)
origin  https://github.com/<YOUR_USERNAME>/commclassroom.git (push)
upstream        https://github.com/commclassroom/commclassroom.git (fetch)
upstream        https://github.com/commclassroom/commclassroom.git (push)

4.) Update Fork Repo From Upstream

  1. Follow these steps if you are done with Setup Remote ✅.
  2. Update your local branch to be in sync with the original repo.
$ git pull upstream development
  1. Update the forked repo by pushing the local repo up.
$ git push origin development

5.) Contributing & PR

  1. Create a new branch.
git checkout -b <your_branch_name>

  1. Perform your desired changes to the code base.

    Make sure to run npm run format

  2. Track your changes:heavy_check_mark: .

git add .
  1. Commit your changes
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests. Please ensure that you compare your feature branch to the desired branch development of the repo to make a PR.

  2. Add an appropriate title and description to your pull request explaining your changes and efforts done. And edit the PR template

  3. Click on Create Pull Request.

Voila ❗ You have made a PR to the Community Classroom repository 💥 Sit back patiently and relax while the project maintainers review your PR. Please understand at times the duration can vary from a few hours to a few days.

PR Review

Your PR will get reviewed soon from the maintainers of the project. If they suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If everything looks good, your PR will be merged. That's it! Thank you for your contribution! Feel free to suggest any changes to this documentation.

Note

Contribution can be very small, that does not matter. We even love to receive a typo fix PR. Adding feature or fixing a bug is not the only way to contribute. You can send us a PR for adding documentation, fixing typos or adding texts.