-
Notifications
You must be signed in to change notification settings - Fork 88
Open
Labels
Points: 10good first issueGood for newcomersGood for newcomersopen-for-allAny one can work on it without getting assigned, every PR can mergeAny one can work on it without getting assigned, every PR can merge
Description
π 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
- Star this repository (top right corner) β
- 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
- Create a folder named after your GitHub username.
- Inside that folder, create a file named
<your-github-username>.txt. - 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
- Go to your forked repository on GitHub.
- Click the yellow banner: "Compare & pull request".
- Add a title and description, then click Create Pull Request.
- 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
Labels
Points: 10good first issueGood for newcomersGood for newcomersopen-for-allAny one can work on it without getting assigned, every PR can mergeAny one can work on it without getting assigned, every PR can merge