Skip to content

Latest commit

 

History

History
157 lines (98 loc) · 6.13 KB

Contributing.md

File metadata and controls

157 lines (98 loc) · 6.13 KB
Raw

Contributing to DoctorVerse

Here are the guidelines to contribute to this open source project.

Prerequisites

You can use the above links to download git and node to your PC, whether it be windows, linux or MacOS.

How to set up the project locally?

Fork the Repository

Firstly, you need a copy of this repository in your own GitHub account. For forking the repository press Fork button to initiate the git forking process.

Forking

You will see a copy of this repository in your GitHub account.

Clone the Repository

After forking the repository you need a copy of it in your local machine.

  • To clone the repository, go to your forked repository page in your GitHub account and press the Code button.

    Clone

  • Select the URL option you prefer to clone the repository onto your local machine and click the copy to clipboard icon.

  • Once done, open Git Bash on your system and change your current working directory to the location where you would like to clone your repository.

  • Once navigated to the directory, use this command to clone the repository in your directory:

    $ git clone https://github.com/Your_Username/DoctorVerse.git

    Use this command directly to clone the project

Adding Upstream Remote

In this stage, you need to set up a new remote to sync your local repository with upstream repository so that you can grab any changes and bring them into your local repository and push the changes to your remote repository. This avoids merge conflicts which most likely happen when working in team environment.

To add the original repository as an upstream remote:

  • Use the following command in your terminal

    $ git remote add upstream https://github.com/jain-rishabh-21/DoctorVerse.git

  • Use following command to see your current remotes

    $ git remote

    You will see the list of your current remotes.
    origin- which points to your GitHub fork of the project.
    upstream- which points to the original project's GitHub repository.

To Run the project

  • Follow the instructions in ProjectSetup.md to set up the local dev environment

Your first Contribution

Unsure where to begin contributing to SpeakEd? 😕
Look for issues tagged with good first issue.

Create a Branch

When you contribute to a project it's good practice to create a new branch from the main branch. The branch name should be short and meaningful and relevant to the work you are intending to do.

To create a new branch, open your terminal or Git Bash.

  • To ensure that you're on the main branch, use the following command:

    $ git checkout main

  • Then use the following command which will sync your local copy with the upstream project and will sync it to your forked repository.

    $ git pull upstream main && git push origin main

  • To create a branch, use this command:

    $ git checkout -b <branchname>

    Now you can start working to fix the issue. 🚀

To Add and Commit the Code

1. First add your code:

$ git add *

This will add all your changed files to the git tracking. We are using the Asterisk(*) here to specify that all the files are to be added. If you want only some files then instead of asterisk use file names.

2. Now commit your code:

$ git commit-m"Your commit message" *

Add your customized message in the -m field. This will commit all your changed files to the git tracking. We are using the Asterisk(*) here to specify that all the files are to be added. If you want only some files then instead of asterisk use file names.

To Create a Pull Request

To create a PR you need to push your branch to the origin remote.

  1. To push a new branch:

    $ git push -u origin <branchname>

    This will create the branch on your GitHub project and the -u flag links your local branch with remote branch, and you can just use git push origin when committing any changes in the local branch.

  2. Finally, go to your forked repository in your browser and press the green button Compare & pull request.

    This will open a page in which you'll be able to further edit the description for your proposed changes.

  3. Make sure you follow the Pull Request Template and your PR's description should contain GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)

  4. Finally, press the green button labelled as Create pull request.

Pull Request title naming conventions

Please make sure to write the titles of your PRs according to the following conventions-

feat(scope): some title here
fix(scope): some title here
docs(scope): some title here
chore(scope): some title here
test(scope): some title here
build(scope): some title here

Keep in mind the following guidelines-

  1. scope must be in lowercase
  2. There must be a blank space after the colon.
  3. The first letter of the title must be in lowercase

To learn more about conventional commit naming click here

Learning Resources 📚