/Hacktoberfest

A beginners friendly repository to help you get started with Hacktoberfest 2022 🚀

Primary LanguageC++MIT LicenseMIT

banner image

A beginners friendly repository to help you get started with your Hacktoberfest 2022 journey🚀.

⚡ How to Contribute

If you have not contributed to hacktoberfest or any open-source software previously then follow these steps:

  1. Go to Hacktoberfest website and sign in there using your GitHub or Gitlab account.

  2. Make sure you installed and setup Git on your local machine. If it isn't, download and install it from here.

  3. Fork this repository by clicking on the Fork button located on top right corner.

  4. Once it is forked, clone the repository in your computer through following command.

git clone url_of_your_forked_copy
  1. This repository consist of 3 modules.

  1. Open a particular module in which you are comfortable, for me its react. Each module contains an application template. Check out the template. Decide your page/section in that module which you want to contribute.

  2. Open an issue through issues tab before start working.

  3. Just make sure someone have not open/request that particular issue before you. In that case you will not be eligible to work on it. The open issue should look something like this:

Module: Put your module name here like React

Page/Section: Put the name of the page/section here on which you want
 to work like About section, login page etc

⚠ Warning: A person can only contribute to a single module, as well as one section or page.

  1. Now navigate to the cloned repository and Open it in your preferred code editor. Also, open a terminal in this directory.

  2. Now type in the following command in the terminal and replace module/section-name with your decided module and section name.

git checkout -b module/section-name

  1. Now start writing your code 💥.

  2. Once you have done all this, commit your changes to GitHub. You can do this with the following commands. Make sure you execute them one by one in order.

# copy and paste the following in the terminal
git add .

# copy and paste the following in the terminal after you have executed the previous command.
git commit -m "Complete section-name of module-name"

# copy and paste the following in the terminal after you have executed the previous command
git push -u origin module/section-name

  1. Now open the forked repository on your GitHub. You will see a box at the top telling you that some changes are pushed. You will also see a button called Compare & pull request. Click on it.

  2. Now add a title, some description and yayyyy! You have opened a pull request in this repository.

  3. Also star this repository and follow me if you haven't yet. 😁

You need to open four valid pull requests in order to complete the challenge. After contributing to this repo you need three more PRs.

⚡ How to make a Pull Request

  1. Go to the pull request tab.
  2. Click on new pull request. 💥
  3. Describe the pull request.
  4. Click on create pull request.
  5. Add any comments and title you want to add with it.

⚡ How to create an Issue

  1. Go to the issues tab.
  2. Click on new issue. 💥
  3. Describe the issue.
  4. Click on submit new issue

📦 Resources

  • If you are contributing for the first time, check this repository.

  • If you don't know how to fork a repository. check this out.

  • If you don't know how to open an issue. Check this out.

  • Want to contribute to other repositories that are participating in Hacktoberfest, click here.

👨‍🎨 For Non Techies

This repository also welcome folks from non-tech background. You can contribute by adding a design template(landing page or web/mobile app) or by improving existing documentation/readme. Waiting for ya. 😉

🔑 License & Conduct

👨🏻‍💻 AUTHOR

🙋🏻‍♂️ Yo! It's Meer, a senior year CS undergrad. Let's get connected

Twitter  LinkedIn  Gmail