Hacktoberfest Beginner's Guide

Welcome to Hacktoberfest! This is a beginner-friendly guide to help you get started with your first Pull Request (PR) for Hacktoberfest. We're excited to have you join the open-source community and contribute to this project.

Getting Started

Step 1: Fork the Repository

Click the "Fork" button in the upper right-hand corner of this repository to create your own copy.

Step 2: Clone Your Fork

Clone the repository to your local machine using the following command (replace <your-username> with your GitHub username):

git clone https://github.com/<your-username>/Hacktoberfest-2023.git

Step 4: Go to Hactoberfest directory by:

cd Hacktoberfest/

Step 5: Installing all the dependency using:

npm install

Step 6: Start your development by:

npm run dev

Now start contributing to the project by:

Step 1: Create a Branch

Create a new branch to work on your changes:

git branch
git branch new-branch-name
git checkout -b my-branch

Step 2: Make Changes

Make the necessary changes or additions to the project. You can add new features, fix bugs, update documentation, or anything else you think is valuable.

Step 3: Commit Your Changes

Commit your changes with a meaningful commit message:

git commit -m "Add a brief description of your changes"

Step 4: Push Your Changes

Push your changes to your fork on GitHub:

git push origin my-branch

Step 5: Create a Pull Request

Go to the original repository on GitHub and click the "New Pull Request" button. Ensure that you're comparing your branch to the main branch of the original repository.

Step 6: Describe Your Pull Request

Write a clear and concise description of your changes in the Pull Request description box. Be sure to mention what issue you're addressing if applicable.

Step 7: Submit Your Pull Request

Click the "Create Pull Request" button to submit your changes for review.

Additional info: For Staged changes

   git reset <- file name ->
   git reset

Committed changes (for many commits)

git reset <-commit hash->
git reset --hard <-commit hash->

Review and Merge

I will review your Pull Requests and, if they are okay, merge them into the main project. Please be patient, as it may take some time for your PR to be reviewed.

Important Notes

• Please don't spam: Ensure that your contributions are meaningful and follow the project's guidelines.

Additional Resources

• Git and GitHub Guide Video
• Youtube video about hacktoberfest

If you have any questions or need help, don't hesitate to reach out. We're here to support you on your Hacktoberfest journey.

Contributors ✨

Thanks go to these wonderful people