Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (92 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

130 lines (92 loc) · 3.48 KB

🌟 Contributing to GitHub Tracker

Thank you for showing interest in GitHub Tracker! 🚀
Whether you're here to fix a bug, propose an enhancement, or add a new feature, we’re thrilled to welcome you aboard. Let’s build something awesome together!


🧑‍⚖️ Code of Conduct

Please make sure to read and adhere to our Code of Conduct before contributing. We aim to foster a respectful and inclusive environment for everyone.


🛠 Project Structure

github_tracker/
├── backend/                  # Node.js + Express backend
│   ├── routes/               # API routes
│   ├── controllers/          # Logic handlers
│   └── index.js              # Entry point for server
│
├── frontend/                 # React + Vite frontend
│   ├── components/           # Reusable UI components
│   ├── pages/                # Main pages/routes
│   └── main.jsx              # Root file
│
├── public/                   # Static assets like images
│
├── .gitignore
├── README.md
├── package.json
├── tailwind.config.js
└── CONTRIBUTING.md

🤝 How to Contribute

🧭 First-Time Contribution Steps

  1. Fork the Repository 🍴
    Click "Fork" to create your own copy under your GitHub account.

  2. Clone Your Fork 📥

    git clone https://github.com/<your-username>/github_tracker.git

  3. Navigate to the Project Folder 📁

    cd github_tracker

  4. Create a New Branch 🌿

    git checkout -b your-feature-name

  5. Make Your Changes ✍
    After modifying files, stage and commit:

    git add .
git commit -m "✨ Added [feature/fix]: your message"

  6. Push Your Branch to GitHub 🚀

    git push origin your-feature-name

  7. Open a Pull Request 🔁
    Go to the original repo and click Compare & pull request.

🚦 Pull Request Guidelines

Split Big Changes into Multiple Commits

  • When making large or complex changes, break them into smaller, logical commits.
  • Each commit should represent a single purpose or unit of change (e.g. refactoring, adding a feature, fixing a bug).
  • ✅ Ensure your code builds and runs without errors.
  • 🧪 Include tests where applicable.
  • 💬 Add comments if the logic is non-trivial.
  • 📸 Attach screenshots for UI-related changes.
  • 🔖 Use meaningful commit messages and titles.

🐞 Reporting Issues

If you discover a bug or have a suggestion:

➡️ Open an Issue

Please include:

  • Steps to Reproduce
  • Expected vs. Actual Behavior
  • Screenshots/Logs (if any)

🧠 Good Coding Practices

  1. Consistent Style
    Stick to the project's linting and formatting conventions (e.g., ESLint, Prettier, Tailwind classes).

  2. Meaningful Naming
    Use self-explanatory names for variables and functions.

  3. Avoid Duplication
    Keep your code DRY (Don't Repeat Yourself).

  4. Testing
    Add unit or integration tests for any new logic.

  5. Review Others’ PRs
    Help others by reviewing their PRs too!

🙌 Thank You!

We’re so glad you’re here. Your time and effort are deeply appreciated. Feel free to reach out via Issues or Discussions if you need any help.

Happy Coding! 💻🚀