Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 2.06 KB
Raw

Contributing

Welcome to OpInCo-Community/HacktoberWeek! Before sending your pull requests, make sure that you read the guidelines carefully. If you have any doubt on the contributing guide, please feel free to reach out and discuss with the community!.

Contributing Guidelines

It is requested of you that -

  1. Start working on the pull request if and only if you are assigned the complimentary issue.
  2. Create good and valuable PR. Go through the Code of Conduct and follow the templates to avoid spam.

How to Contribute

Installation Guide

Before getting started let's install the project on your system!!

1. 🔨 Setup & Run

Visit our GitHub repository and click on the Fork option in the top right corner of your GitHub account. This creates a copy of the repository.

2. Clone the repository

git clone command creates a copy/clone of the repository in you local system.

--> You can clone this repo by using the below command and navigate to the directory.

git clone https://github.com/<YOUR_USERNAME>/HacktoberWeek.git
cd HacktoberWeek

3. Setup Remote

git remote add upstream https://github.com/HacktoberWeek/HacktoberWeek.git

4. Sync your fork or your local repository with the origin repository

git checkout main
git fetch upstream
git merge upstream/main

5. Create a PR

After you are done making all the requisite changes. Push your changes to the repository and create a good PR. To do so go through the Contributing Guidelines

PR Review

Your PR will get reviewed soon! If the maintainers suggest changes, do all the changes, commit the changes, rebase the branch, squash the commits and push the changes. If everything looks good, your PR will be merged. That's it! Thank you for your contribution!

All the best! 🥇