Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
318 lines (205 loc) · 6.16 KB

CONTRIBUTING.md

File metadata and controls

318 lines (205 loc) · 6.16 KB
Raw

Contributing to AppCosmos 🚀

Thank you for your interest in contributing to AppCosmos!

This repository is part of OpenCode ’25, a month-long open-source program by GeekHaven, IIIT Allahabad.

AppCosmos is a design-focused repository aimed at creating and prototyping real-world mobile and web applications for GeekHaven.

📌 Mentor

Sankalp Joshi

📑 Table of Contents

🧩 About the Project

🎯 Goal

To learn, practice, and master app UI/UX design by working on real product-style problems using Figma.

You will gain hands-on experience with:

  • UI component creation
  • Auto-layout & constraints
  • Variants & components
  • Design systems
  • Interactive prototypes
  • App-first UX thinking

Note: Try to maintain a single Figma file for tasks of this repository.
The complete theme of the app (all pages you design) must remain consistent.

🚀 Getting Started

🔐 Registration (MANDATORY)

  1. Register on Unstop for OpenCode ’25
  2. Register at https://events.geekhaven.in/
  3. Join the OpenCode Discord server (mandatory for updates & mentor support)
  4. Watch this repository on GitHub

🍴 Fork & Clone

git clone https://github.com/opencodeiiita/AppCosmos.git
cd AppCosmos

✅ Prerequisites

  • Basic understanding of Git/GitHub
  • Familiarity with Figma
  • Curiosity and willingness to learn
  • No prior advanced design experience required

🏷️ Understanding Issue Types

There are three types of issues in AppCosmos:

1️⃣ Open-For-All (OFA) Issues

  • No claiming required
  • Anyone can work on them
  • Multiple PRs accepted
  • Lower points
  • Best for beginners

2️⃣ Competitive Issues

  • No claiming required
  • Multiple submissions allowed
  • Only the best PR gets points
  • Judged by the mentor
  • Higher points
  • Ideal for showcasing your best design skills

3️⃣ First-Come Issues

  • Must be claimed first
  • Assigned to the first commenter
  • Max 3 first-come issues across all OpenCode repos
  • Only 1 first-come issue per repo at a time
  • Time limit: 2 days (+ max 12 hours extension with approval)
  • Missed deadline → cannot work on that issue again

🛠️ How to Contribute

Step 1: Browse Issues

  1. Open the Issues tab
  2. Read issue descriptions carefully
  3. Check tags, difficulty, and points

Step 2: Claim an Issue (First-Come Only)

Comment on the issue:

/claim

Wait for mentor assignment before starting.

Step 3: Work on Your Design

  1. Create a new branch:
git checkout -b issue-X-your-design-name
  1. Design according to issue requirements
  2. Ensure scalability across screen sizes
  3. Maintain app-centric UX logic

Step 4: Organize Files

Follow the folder structure below 👇

📁 File Formats & Structure

Note: If the folder with your college name already exist don’t make a new folder, create the file in the existing folder.

/college-name
 └── enrollment-number.txt

Example:

/IIIT Allahabad
 └── IEC2024047.txt

enrollment-number.txt

enrollment-number.txt file must contain the link to your figma project. Make sure to give view access to anyone with the link.

Figma Link:
https://www.figma.com/file/XXXXXXXXXXXX

Examples:

🔁 Pull Request Guidelines

⚠️ CRITICAL: PR Template Rules

Your PR will NOT be counted for points if these are not followed.

PR Title

Example

Issue#3 – AppCosmos Dashboard UI

PR Description

FIRST LINE MUST BE:

Issue:#3

Then include(Optional):

  • Design approach explanation
  • Preview images or videos
  • Figma link
  • Any assumptions or notes

✅ PR Checklist

  • Repository forked
  • New branch created
  • No merge conflicts
  • Correct PR title
  • First line: Issue: #X
  • Correct folder structure
  • Source files included
  • Exports included
  • README.md added
  • Previews attached
  • Design meets issue requirements

📌 Rules & Important Notes

General Rules

  1. Original Work Only – No plagiarism
  2. Be respectful to mentors and contributors
  3. Follow time limits strictly
  4. One PR per issue
  5. No spamming or fake claims

Issue Limits

  • Max 3 first-come issues across all repos
  • Only 1 first-come issue per repo at a time
  • No limit on OFA & Competitive issues

🎨 Design Guidelines

  • App-first UX thinking
  • Clean visual hierarchy
  • Consistent typography & spacing
  • Scalable components
  • Accessibility-friendly colors
  • Production-ready designs

🆘 Getting Help

Where to Ask

  1. OpenCode Discord (fastest)
  2. GitHub issue comments (mention mentor)

Mentor Can Help With

  • Clarifying requirements
  • Design feedback
  • Direction suggestions

❌ Mentors will NOT design for you.

🔗 Resources

❓ FAQ

Q: Can I work on multiple issues?

Yes. OFA & Competitive issues are unlimited. First-come max is 3 across all repos.

Q: What if I miss a first-come deadline?

You lose eligibility for that issue permanently.

Q: Can I submit multiple designs?

Yes, but only the best submission gets points (for competitive issues).

❤️ Final Note

Thank you for contributing to AppCosmos and being a part of OpenCode ’25.

Design boldly, think like a product designer, and keep learning 🚀

Enjoyyyy! 🎨📱