Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (64 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

97 lines (64 loc) · 2.31 KB

🏁 Contributing to NightTime-Highway

Welcome to NightTime-Highway – an open-source car game built for fun and learning! 🚗🌃
We're excited that you're interested in contributing. Here’s everything you need to get started.

Repo: https://github.com/szg-zone/NightTime-Highway/

📌 How to Contribute

  1. Fork this repository.

  2. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/NightTime-Highway.git
cd NightTime-Highway

  3. Create a new branch:

    git checkout -b feature-your-feature-name

  4. Make your changes.

  5. Commit with a clear message:

    git commit -m "Add: Short description of your changes"

  6. Push your branch:

    git push origin feature-your-feature-name

  7. Open a Pull Request to the main branch on:
    https://github.com/szg-zone/NightTime-Highway/compare

🧠 What You Can Contribute

  • 🚗 Game mechanics (e.g. speed, controls, car AI)
  • 💥 Bug fixes
  • 🎨 New assets (cars, roads, backgrounds)
  • 🧩 Features (e.g. score system, power-ups)
  • ⚡ Optimizations
  • 📖 Documentation updates

🎯 Code Style & Standards

  • Use descriptive variable and function names.
  • Match the existing code style (indentation, naming).
  • Keep your code clean and modular.
  • Document complex logic with comments.

✅ Pull Request Checklist

Before opening a PR:

  • The code builds and runs successfully.
  • No unused or debug code is left behind.
  • Code follows formatting and naming conventions.
  • Any UI/visual change includes a screenshot or recording.
  • You’ve described what your PR does.

🐛 Reporting Issues

If you encounter a bug or want to suggest a feature:

  1. Check existing issues.
  2. Open a new issue with:
    • A clear title
    • Steps to reproduce (if a bug)
    • Expected vs actual behavior
    • Screenshots or logs (if available)

💬 Questions or Suggestions?

Feel free to open an issue or start a discussion. We’re happy to help!

Thanks for being part of NightTime-Highway!
Let’s build something awesome together. 🚦