Skip to content
Gencraft

Contributing

Gencraft is open source under AGPL-3.0, and help is welcome. The easiest ways to help, from least to most work:

  1. Report a problem or suggest something. Open an issue on GitHub. Model requests are welcome: say which model and which provider.
  2. Improve these guides. Every page here is a file in docs-site/src/content/docs/. A fix to a sentence is a good first contribution.
  3. Add content packs. Effects, transitions, caption styles, text styles, elements and templates are plain data files in content/. They are checked automatically, and the maintainer signs and publishes them after a merge.
  4. Fix a bug. Keep each pull request to one change, and make sure the checks pass.

Open your pull request against the dev branch (a pull request aimed at main is moved there for you): main holds released versions only, and the maintainers carry what is merged into dev into the next release.

Before your first pull request is merged, a bot asks you to sign a short contributor agreement once. It lets the owner include your work in the official paid build as well as in the open source code.

Building from source, the checks and the rules for pull requests are in CONTRIBUTING.md. The name Gencraft and its logo are trademarks: see TRADEMARK.md.