Skip to content

Contribute to Gargantuan

We have a code of conduct that we all must follow. Be polite to everyone. If you are not in your best day, take a deep breath and try again.

  • There is a separate guide for working on Gargantuan.
  • Do not use AI to generate issue or PR descriptions. You will get banned for spam without review. We want contributions from people, not bots.
  • Likewise, do not use AI to generate documentation, models, artwork, etc. AI usage must be constrained to only code.
  • Search existing issues before opening a new bug report or feature request.
  • When creating an issue, please be as specific as possible.
  • Please do not create duplicate issues. Team Fireworks reserves the right to ban you for repeatedly wasting our time through ignorance.
  • For non-trivial changes, start with an issue and wait until a maintainer confirms the bug or agrees that the feature should be implemented.
  • If an issue you want to work on is stale, mention an active maintainer and show your intent to contribute. Please don’t waste time on features that will not be implemented into Gargantuan.
  • To make code review and CI easier, please keep changes minimal and focuses. You may break up large changes into multiple pull requests. Please don’t be like Spook..

Before opening a pull request, make sure that:

  • The change is tied to an approved feature request or confirmed bug.
  • The branch builds and runs without issues and has been thoroughly tested. Otherwise, the pull request is marked as draft.
  • The pull request description clearly explains the change scope. The description includes visuals (screenshots, videos) if applicable.
  • You mention which platforms you tested on.
  • The branch is rebased on main, or at least the latest Chromium milestone.
  • Small and focused pull requests are much easier to review. Please split your changes into several follow-up PRs if necessary.