Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

93 lines (69 loc) · 2.99 KB
Raw

Contribution Guide to Web Dev Projects - HacktoberFest 2024

🎉 Welcome to Hacktoberfest 2024 🎉

We’re excited to have you here and appreciate your interest in contributing to our project. Whether you’re a beginner or an experienced developer, all contributions are valuable!
And to spread the word of Open-Source, make sure to star this repository🌟

Prerequisites

Before you begin, ensure you have the following installed:

  • Git
  • Node.js and npm (if applicable)
  • Any specific tools/libraries your project relies on.

What to Contribute?

This repository is specifically marked for Web Development Projects. Please stick to the project type to make organizing things easier. If you wish to contribute elsewise, please find appropriate repositories on SamarthTech .
There are several ways you can contribute here:

  • Fix outstanding issues with the existing code
  • Submit issues related to bugs or desired new features
  • Add new features or new projects by yourself
  • Be Creative !

Note

All contributions are equally valuable to the community. 🥰

Get Started

Step 1: Fork the Project

  1. Navigate to the repository you'd like to contribute to.
  2. Click the "Fork" button on the top right of the repository.

Step 2: Clone Your Fork

Clone your forked repository to your local machine and Move into it:

git clone https://github.com/<username>/<repository-name>.git
cd <repository-name>
  • Add a completely new project or feature by yourself by creating a sub-directory and Move to your project:
mkdir your-project-name
cd your-project-name

OR

  • Choose an existing project to contribute and Move into the directory:
cd project-name

Step 3: Create a New Branch

To keep your changes isolated, always create a new branch before working on your contribution:

git checkout -b feature/new-feature

Step 4: Make Your Changes

Make your changes, whether it’s fixing a bug, adding a feature, or updating documentation.

Step 5: Commit Your Changes

git add .
git commit -m "Brief description of the changes"

Step 6: Push to Your Fork

Push your changes to your forked repository:

git push origin your-feature-branch

Step 7: Create a Pull Request

Go to the original repository on GitHub. Click the "New Pull Request" button. Select the branch you want to merge into the base repository. Provide a meaningful description of the changes made.

How to Choose an Issue

Browse through the Issues section. Look for issues labeled Hacktoberfest, good first issue, or help wanted. Comment on the issue to let others know you're working on it. Wait for a maintainer to assign the issue to you before starting work.

Mission Accomplised 🚀

Get 4 Pull Requests Merged successfully to complete the quest of Hacktoberfest 2024. Get digital badges, rewards, certificates and more. Keep Contributing to Open-Source!