Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (41 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1.43 KB

🤝 Contributing to GitHub Profile Search App

Welcome! 🎉 We're excited that you're interested in contributing to this project. Whether you're fixing bugs, improving UI, adding features, or enhancing documentation — your input is valued.

🧰 Project Overview

This is a responsive, animated GitHub profile search app built with:

  • HTML5
  • SCSS (modular styling)
  • JavaScript (vanilla)
  • Features include:
    • Starry animated background
    • Observer-driven UI transitions
    • GitHub API integration

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/your-username/github-profile-search.git

Create a new branch:

bash git checkout -b feature/your-feature-name Make your changes

Commit with a clear message:

bash git commit -m "Add: feature description" Push to your fork:

bash git push origin feature/your-feature-name Open a Pull Request on the original repo

✅ Contribution Guidelines Keep code modular and readable

Follow existing naming conventions

Ensure responsive design across devices

Test your changes before submitting

For UI changes, include screenshots in your PR

📦 Folder Structure Code 📁 dist/ → Compiled CSS & JS 📁 src/ → Source SCSS & JS 📄 index.html → Main HTML file

💬 Need Help? Open an issue or start a discussion — we’re happy to collaborate!

Thanks for contributing! 🌟 Created by @MuradIsazade777