Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
168 lines (107 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

168 lines (107 loc) · 3.35 KB

🤝 Contributing to Pixel Phantoms Website

Thank you for your interest in contributing!
Pixel Phantoms is a fully open-source, student-friendly project, and we welcome contributors of all skill levels.
Please follow the guidelines below for a smooth and successful contribution.

📌 Getting Started

1️⃣ Fork the Repository

Click on the Fork button at the top-right of this GitHub repo.

2️⃣ Clone Your Fork

https://github.com/sayeeg-11/Pixel_Phantoms.git
cd pixel-phantoms

3️⃣ Create a Feature Branch

Always create a new branch for your feature or fix:

git checkout -b feature-your-feature-name

🧰 Project Setup

Since this is a static website, no backend setup is required.

✔ Requirements:

  • Any code editor (VS Code recommended)
  • Basic knowledge of HTML, CSS, and JavaScript

✔ To run locally:

Open index.html directly OR Use VS Code → Right-click → Open with Live Server

📝 What You Can Contribute

✔ Code Contributions

  • Improve UI/UX
  • Fix layout or responsiveness issues
  • Add animations or components
  • Enhance JavaScript interactivity
  • Add new pages (Events, Gallery, Projects, Blogs, etc.)

✔ Content Contributions

  • Write or update text in pages
  • Update committee or club details
  • Improve documentation (README, Roadmap, Guidelines)

✔ Design & Media

  • Add banners, logos, posters
  • Update icons, illustrations, images

⚠ Contribution Rules (Very Important)

Before submitting any pull request:

✔ Follow Code Style

  • Use clean, readable HTML/CSS/JS
  • Follow existing structure and naming conventions
  • Indent code properly (2 or 4 spaces)

✔ File Guidelines

  • ❌ DO NOT add large media files unless required
  • ❌ DO NOT commit .vscode/, node_modules/, or system files
  • ✔ Add assets inside the correct folders (assets/images, assets/icons, etc.)

✔ Commit Message Guidelines

Use meaningful messages:

Add: New gallery section
Fix: Navbar alignment issue
Update: Committee details
Refactor: CSS for responsiveness

✔ Required for UI Changes

Include before/after screenshots in your Pull Request.

📤 Submitting a Pull Request

Once your feature is ready:

git add .
git commit -m "Describe your change clearly"
git push origin feature-your-feature-name

Then open GitHub:

  1. Go to your fork
  2. Click Compare & Pull Request
  3. Add screenshots (if UI changes)
  4. Add a clear description
  5. Submit 🎉

🐞 Creating Issues

Before starting work, create an Issue:

Issue Should Include:

  • What change/feature you want to add
  • Why it’s needed
  • Screenshots (if UI related)
  • Estimated time (optional)

Wait for a project admin to assign the issue to you.

🤝 Code of Conduct

By contributing, you agree to:

  • Be respectful and supportive
  • Help beginners who ask questions
  • Keep discussions constructive
  • Follow open-source etiquette
  • Avoid spamming issues or PRs

💬 Need Help?

If you're confused or stuck at any step:

  • Open an Issue
  • Tag mentors in comments
  • Reach out to the maintainers
  • Contact our community team

We’re here to help you grow! 🌱

🎉 Welcome to the Pixel Phantoms Community!

Thank you for contributing your time, skills, and creativity. Together, let's build something amazing! 🚀👻