Skip to content

Add Yourself as a ContributorΒ #1

@Vichanshu

Description

@Vichanshu

🌟 Become a Contributor!

Welcome to the Learn_To_Hack contributors guide! Follow these simple steps to add yourself as a contributor and join our awesome community. πŸš€


🟒 Objective

Add yourself as a contributor to this repository by following a simple GitHub workflow. This is a great way to get comfortable with open source collaboration!


⭐ Step 1: Star & Fork

  1. Star this repository (top right corner) ⭐
  2. Fork it to your own GitHub account 🍴

πŸ“‚ Step 2: Clone & Branch

Open your terminal and run:

# 1. Clone your forked repository
git clone https://github.com/<your-username>/Learn_To_Hack.git

# 2. Enter the repository folder
cd Learn_To_Hack

# 3. Create a new branch (always use a branch for new features!)
git checkout -b add-contributor-<your-username>

# 4. Navigate to the contributors directory
cd CONTRIBUTORS

πŸ“ Step 3: Add Your Contribution

  1. Create a folder named after your GitHub username.
  2. Inside that folder, create a file named <your-github-username>.txt.
  3. Add your details to the text file following the format in template.txt.

Directory Structure Example:

CONTRIBUTORS/
β”‚
└── YOUR_GITHUB_USERNAME/          <-- Create this folder
	└── YOUR_GITHUB_USERNAME.txt   <-- Create this file

An example folder mamed Jogn Doe has been made for you.

Example file content:

Name: John Doe
College: University of Technology
Fun Fact/Story: I once wrote code that compiled on the first try!

πŸš€ Step 4: Commit & Push

# 1. Stage your changes
git add .

# 2. Commit your changes with a message
git commit -m "Added <your-username> to contributors list"

# 3. Push the changes to your fork
git push origin add-contributor-<your-username>

✨ Step 5: Open a Pull Request

  1. Go to your forked repository on GitHub.
  2. Click the yellow banner: "Compare & pull request".
  3. Add a title and description, then click Create Pull Request.
  4. Make sure that your PR template is correct.

##Example PR

Issue : #1

Added myself in the contributors list

πŸŽ‰ That’s It!

This process helps you get comfortable with forking, branching, committing, and opening pull requests. We’re excited to have you on board!

Happy contributing! ✨

Metadata

Metadata

Assignees

No one assigned

    Labels

    Points: 10good first issueGood for newcomersopen-for-allAny one can work on it without getting assigned, every PR can merge

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions