Skip to content

Latest commit

 

History

History
81 lines (53 loc) · 1.74 KB

File metadata and controls

81 lines (53 loc) · 1.74 KB

✨ Contributing Guide

Thank you for considering a contribution! Simple Game Engine is built on curiosity, creativity, and care—and you are part of that magic.


🧩 Ways to Contribute

  • 📚 Improve documentation or fix typos
  • 🐛 Report bugs using our templates
  • 🌟 Suggest new features or enhancements
  • 🧪 Write or improve tests
  • 🔧 Refactor or optimize code
  • 🗣️ Join the conversation in GitHub Discussions

🛠 Getting Started

1. Fork + Clone

git clone https://github.com/your-username/simple-game-engine.git
cd simple-game-engine

2. Create a Branch

git checkout -b feat/amazing-idea

3. Make Your Changes

git add .
git commit -m "Add: your amazing contribution"
git push origin feat/amazing-idea

📦 Open a Pull Request

  1. Go to GitHub and open a Pull Request
  2. Use the Pull Request Template
  3. Reference related issues (e.g. Closes #3)
  4. Write clearly and kindly—we want to celebrate your work!

🤖 Code Style & Conventions

  • Follow formatting rules (black, etc.)
  • Stick to existing folder and naming conventions
  • Keep code modular, clean, and minimal where possible

💖 What We Value

We especially appreciate:

  • Kind and constructive communication
  • Attention to clarity (docs are love!)
  • Inclusivity and accessibility
  • Learning in public and sharing growth

🌿 Final Notes

Not sure where to start? Open a Discussion or draft a PR early to get feedback.

You're not just contributing to code—you’re helping build a weird and wonderful toolkit for narrative games.


With gratitude, — The simple-game-engine Team