Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.03 KB

Project-2 Contribution Guide

Welcoming all CONTRIBUTORS who help in making this repo whole again.

Before you guys begin, please make sure that you abide by the terms of the CODE_OF_CONDUCT.

We have created a RoadMap for easier navigation and to provide information about the existing issues and lots of todos. Please have a look for inspiration.

This document is a quick guide through for you guys with all the steps from new Issue creation, forking the repo, creating, reviewing and merging the Pull Requests.

Steps Involved

Issue Check

  • First step would be to check if any issue does exist towards which a contribution can be made.

New Issue

  • If some bugs are found and needs some fixing, please create a new issue by clicking on the New issue option.

Forking Repo

  • Now, go ahead and fork the repo onto your local machine to start making your changes.

Pull Requests (PR)

  • When done with making your changes, open a pull request by clicking on the New pull request option.
  • Provide a short description of the changes you have made.
  • Please add comments in your code wherever necessary.
  • If you fixed an existing issue please update the issue as well.
  • Please tag one of the existing contributors for reviewing as well.

PR Review

  • Once after submitting a pull request, we will be reviewing it and get back to you on any questions regarding the changes made.

  • Check the git tutorial on resolving any merge conflicts encountered.

PR Merged

  • 🎉 Thank you for your contribution !!!
  • You will be added as a contributor to the contributors list.