Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.79 KB
Raw

Contributing to fennecs

Welcome to our Community! 🦊

First and foremost, thank you for your interest in contributing to fennecs! Your involvement makes this project truly special and helps shape its future.

How You Can Make a Difference

meme, fennec, hotline bling, approving

There are numerous ways to contribute, each equally valuable:

  • 🐛 Reporting bugs and issues
  • 👀 Reviewing issues and Pull Requests (PRs)
  • 🛠️ Submitting or reviewing PRs for bug fixes
  • 📚 Improving documentation
  • 🎮 Creating or enhancing demos (we can never have too many!)
  • 🗣️ Sharing your fennecs-powered games or simulations
  • 🧪 Adding unit and integration tests (the more, the merrier!)

Current Project Status

fennecs is in its early stages, which means it's highly flexible and open to evolution. While this is exciting, it also means we need to be mindful of its direction.

meme, fennec, hotline bling, approving

⚠️ Important Note: We're currently focused on realizing the core vision of fennecs. As such, unsolicited feature additions might not be accepted. To avoid disappointment, please discuss substantial changes with us before investing your valuable time.

However, we absolutely encourage you to experiment and build anything you like in your own forks of fennecs. We'd love to hear about your creations!

Need Help?

For support questions, please join our vibrant community on Discord. The issue tracker is reserved for bug reports and feature discussions.

Ground Rules

  1. New contributors should submit their work as Pull Requests via GitHub.
  2. All contributions must be compatible with the MIT license. If you're including MIT-licensed work from others, please let us know so we can properly attribute them.
  3. As fennecs is distributed as a .NET package on NuGet (and potentially other registries), contributions should not introduce dependencies to other packages or include game-engine-specific code paths.
  4. Engine-specific code and bindings are welcome, but in supplementary packages (e.g., the fennecs-godot addon).

Attribution

We value your contributions! Contributors will be listed in the project's MIT LICENSE file. We'll use your real name if provided, or your GitHub username otherwise. The order is based on commit counts as shown in the Contributors section on GitHub.

Thank You!

fennecs is crafted with 💘 love & foxes 🦊, but it's made by amazing people like you!

Your passion, creativity, and effort drive this project forward. Let's build something extraordinary together!