Skip to content

Latest commit

 

History

History
77 lines (63 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

77 lines (63 loc) · 3.41 KB
Raw

CONTRIBUTING GUIDELINES

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to resolve the Bugs in the Code submitted on this Repository. You can even help us in developing some new problems by raising appropriate issues which will be reviewed by the Project Administrators.

Submitting Contributions👩‍💻

Below you will find the process and workflow used to review and merge your changes.

Step 0 : Explore the Codebase

  • Take a look at the Existing Codes in various directories.
  • Find Specific Bugs in the Code and raise an Issue once you start working on one.
  • Note: Every Bug Fix in this project should/must have an associated issue.

Step 1 : Fork the Project

  • Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in upstream remote.
$ git clone https://github.com/<your-username>/<repo-name>
$ cd <repo-name>
$ git remote add upstream https://github.com/<upstream-owner>/<repo-name>
  • If you have already forked the project, update your copy before working.
$ git remote update
$ git checkout <branch-name>
$ git rebase upstream/<branch-name>

Step 2 : Branch

Create a new branch. Use your Github Username for addressing the bug you are trying to fix.

# It will create a new branch with name Branch_Name and switch to that branch 
$ git checkout -b branch_name

Step 3 : Work on the issue assigned

  • Work on the issue(s) assigned to you.
  • Add all the files/folders needed.
  • After you've made changes or made your contribution to the project add changes to the branch you've just created by:
# To add all new files to branch Branch_Name
$ git add .

Step 4 : Commit

  • To commit give a descriptive message for the convenience of reveiwer by:
# This message get associated with all files you have changed
$ git commit -m 'message'
  • NOTE: A PR should have only one commit. Multiple commits should be squashed.

Step 5 : Work Remotely

  • Now you are ready to your work to the remote repository.
  • When your work is ready and complies with the project conventions, upload your changes to your fork:
# To push your work to your remote repository
$ git push -u origin Branch_Name

Step 6 : Pull Request

  • Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
  • Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳

Need more help?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Tip from us😇

It always takes time to understand and learn. So, do not worry at all. We know you have got this!💪

Contributing template is from DSC-SIST