Skip to content

DevUp-Society/Github-contributions

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 Portfolio Showcase Contribution Repo

Welcome to the Research and Innovation Team Portfolio Showcase 🚀

This repository is created for our GitHub hands-on workshop to help first-year students learn how open-source contributions work in a real project.

Each student will contribute by adding:

  • a short intro card on the main page
  • their own portfolio page
  • a working View Portfolio link

This helps you learn real GitHub contribution workflow in a simple way.


🎯 Contribution Flow

Every student will work on only their own section.

The project structure is:

portfolio-showcase/
│
├── index.html
├── style.css
├── script.js
│
└── portfolios/
    ├── john-doe.html
    ├── karthik.html
    ├── rahul.html

🌐 What You Need to Do

You need to contribute in 2 places only:

1) Add Your Intro Card in index.html

<div class="card">
    <h3>John Doe</h3>
    <p>1st Year CSE</p>
    <p>AI enthusiast and web developer</p>
    <p>Passionate about building projects</p>
    <a href="portfolios/john-doe.html">View Portfolio</a>
</div>

⚠️ Keep your intro within 4–5 lines only


2) Create Your Own Portfolio Page

Inside the portfolios/ folder, create your own file only

Your portfolio must be a single HTML file only (write HTML/CSS/JS inside the same file).

✅ valid examples:

portfolios/john-doe.html
portfolios/karthik.html
portfolios/rahul.html

❌ do not create portfolio files outside portfolios/

Example:

portfolios/john-doe.html

🚨 Important Guidelines

✅ Edit Only Your Own Files

Only edit:

index.html
portfolios/your-name.html

Example:

index.html
portfolios/john-doe.html

❌ Do NOT Edit Others' Files

Do not touch:

  • someone else’s card
  • someone else’s portfolio file
  • CSS unless assigned

🔄 ALWAYS PULL LATEST UPDATES

Before you start working, always run this command first:

git pull origin main

This gets the latest file updates from the main branch.

⚠️ This is compulsory before starting your work.


🔁 Pull Again Before Pushing

Before you push your changes, always pull once again:

git pull origin main

This ensures you have the latest updates from others and helps avoid merge conflicts.

So the flow is:

pull → edit → status → commit → pull → push

🌿 Check Your Branch First

Always check your branch:

git branch

Example:

* john-doe
  main

The * means current branch.


🔁 If You Are in the Wrong Branch

Go back using your branch name.

Example:

git checkout john-doe

👀 ALWAYS CHECK WHAT IS BEING EDITED

Before committing or pushing, always run:

git status

This shows what files are changed.

Example:

modified: index.html
modified: portfolios/john-doe.html

✅ correct

If you see someone else’s file:

portfolios/rahul.html

❌ do not commit it


🚀 Contribution Steps

1) Clone Once (Skip if already cloned)

git clone <repository-url>
cd portfolio-showcase

2) Create Issue First and Get Assigned

Use GitHub website first.

Optional GitHub CLI:

gh issue create --title "Add your-name portfolio" --body "I will add data/your-name.json and portfolios/your-name.html"

3) Sync Main and Create Your Branch

git checkout main
git pull origin main
git checkout -b your-name
git pull origin main

4) Make Your Changes Only in These Two Files

portfolios/your-name.html
data/your-name.json

5) Check Changes and Add Only Your Files

git status

# example
git add portfolios/john-doe.html data/john-doe.json

6) Commit and Push to Your Branch

git commit -m "Add your-name portfolio"
git push -u origin your-name

7) Raise Pull Request (Use PR Template)

Create PR from your-name branch to main.

Optional GitHub CLI:

gh pr create --base main --head your-name --title "Add your-name portfolio files" --body "Closes #issue-number"

🎯 Goal of This Workshop

By contributing here, you will learn:

  • Forking
  • Branching
  • Pulling latest updates
  • Checking edited files
  • Creating portfolio pages
  • Raising Pull Requests

Happy Contributing 🚀

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 58.3%
  • CSS 24.2%
  • JavaScript 17.5%