Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.61 KB

Contribution.md

File metadata and controls

65 lines (38 loc) · 2.61 KB

📌 Getting Started⭐ Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

If you don't have git on your machine, install it.

  1. Watch this video to get started, if you have no clue about open source - https://youtu.be/SL5KKdmvJ1U
  2. Forking a Repo - https://docs.github.com/en/get-started/quickstart/fork-a-repo
  3. Cloning a Repo - https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
  4. How to create an Issue - https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue
  5. How to create a Pull Request - https://opensource.com/article/19/7/create-pull-request-github
  6. Getting started with Git and GitHub - https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6

📜 Instructions to follow while contributing:

FORK THIS REPOSITORY AND WORK ON THE CLONE DON'T CHANGE MAIN

Below are the steps to follow to contribute to this project:

  1. Fork this repository.

  2. Clone your forked copy of the project.

''git clone --depth 1 https://github.com/<your_user_name>/backend.git'' where your_user_name is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

  1. Navigate to the project directory 📁 .

  2. Now Open Your Favourite Text-Editor and run the command in terminal: .

npm install 5. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/TheCleverIdiott/SENMETER 6. Check the remotes for this repository.

git remote -v 7. Always take a pull from the upstream repository to your main branch to keep it at par with the main project (updated repository).

git pull upstream main 8. Create a new branch.

git checkout -b <your_branch_name> 9. Make necessary changes and commit those changes

  1. Track your changes✔️ .

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 you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

  2. Add appropriate title and description to your pull request explaining your changes and efforts done.

  3. Click on Create Pull Request.

16.Sit back patiently and relax till then the project maintainers will review your PR. Please understand, there will be some time taken to review a PR and can vary from a few hours to a few days too so be Patient and keep contributing.