Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 3.33 KB

READ CODE OF CONDUCT Read the Code of Conduct before starting contributing.

Coding conventions to be followed -

  1. Maintain a proper project folder structure
  2. Follow proper naming conventions
  3. Read the instructions - Hacktober fest 2022

Getting Started

  1. If you are new to Git and GitHub, it is advisable that you go through GitHub For Beginners before moving to ahead.

  2. Pick any issue you want to work on from the issues, discuss with maintainer on issue and then start.

  3. Fork the project on GitHub. Help Guide to Fork a Repository. fork After a sucessful fork, you'll see a copy of this repo in your own account.

  4. Clone the project.

    git clone https://github.com/clubgamma/task-tracker

    Help Guide to Clone a Repository

  5. Create a branch specific to the issue you are working on.

    git checkout -b branch-name

    (Take inspiration for branch name from the issue you are working on!)

  6. Open up the project in your favorite text editor.

    Select the file you want to contribute to, and make your changes.

    If you are making changes to the README.md file, you would need to have Markdown knowledge. Visit here to read about GitHub Markdown and here to practice.

  7. Add your modified files to git, How to Add, Commit, Push, and Go.

    You can also add all unstaged files using:

    git add .

    Note: using a git add . will automatically add all files. You can do a git status to see your changes, but do it before git add.

  8. Commit your changes using a descriptive commit message.

    git commit -m "Brief Description of Commit"

  9. Push your commits to your GitHub Fork:

    git push -u origin branch-name

  10. Submit a pull request.

Submitting a Pull Request

What is a Pull Request?

  • Create a pull-request by clicking the button
  • Add the link of the issue you are addressing in the pull request
  • Mark the pull request as Ready for Review (If you forget this step then your pull request won't be counted) if you are working in draft pull request

image

Also add the below 2 lines in the description. It is compulsory for sucessful submission.

  • I have read the Code Of Conduct.

  • I have followed all the steps of submission properly.

image

Woohoo!! Congratulations on making your open source contribution🎉🎉

Wait for some time to get your PR merged by our team