Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 2.12 KB

File metadata and controls

41 lines (30 loc) · 2.12 KB

Contributing to cuneus

cuneus is built by human(s), for human(s) for learning, for fun, and for making cool things. Whether you're fixing a typo, reporting a bug, landing a new engine feature etc etc thank you 🙂 Here's how to make your contribution easy to review and easy to trust.

Reporting bugs

Open an issue with enough detail to reproduce it:

  • your OS, GPU, and graphics backend
  • which example/shader and the steps to trigger it
  • what you expected vs. what happened etc
  • logs/screenshots/short any recordings where they help

Changes and features

For small things or bug fixes that you can reproduce just open a pull request. For larger arch changes or features, it helps to open an issue first describing what you're trying to achieve could be really helpful to discuss together :-)

AI / LLM contribution policy

Cuneus is built by human(s), for human(s), and the rules below exist for one reason: you take full responsibility for what you contribute.

This policy is adapted from GTK's AI contribution policy, which inspired most of the thinking here.

  • You own it. If you used an AI tool, you are still 100% responsible for the change. "The AI wrote it","AI suggested it", "AI verified it" is never an explanation, and never a defense.
  • Understand and test what you submit. Run it. Verify it does what you claim. Do not open a PR for code, docs, or tests you can't explain yourself.
  • Don't fabricate. No invented benchmarks, test results, bug reports, or reproducers.
  • Respect licensing and attribution. Don't launder someone else's work through a model; credit what you build on.
  • Disclose AI use in the PR description if you used an AI, a sentence on what you used and how you verified it. Please don't add Co-authored-by: / Assisted-by: trailers to commits; the responsibility is yours to state in your own words, not a llm to advertise.

If you can stand behind it and explain it, it's welcome here. That's the whole bar and it's the same bar a human writing every line by hand would meet.