Contributing

Styleguide

Workflow

We expect external contributors to comply with the following conventions:

• We follow the Minifesto
• We follow the Agile Manifesto
• We follow the SemVer guidelines
• We follow the Keep a Changelog guidelines
• We follow the VFX Reference Platform recommendations when they fucking make sense.

Python

• We format with Black
• We respect the PEP 20 (Zen of Python)
• We respect the PEP 8 (Style guide)
• We follow the Google Style Guide
• We strictly format our docstrings following the Google style

Code of conduct

We respect and enforce the Contributor Covenant.

Bip

API

Contributions are welcome, but since Bip is not yet production-ready and since its development is driven by our studio need, please get in touch with us before starting any contribution that is meant to be merged into the official codebase.

Plugins

When maintaining a Bip plugin, do make sure you are strictly following the plugin guidelines regarding repository structure, Git tags naming and changelog formatting.

If you are publishing your plugins on our Gitlab instance, we also strongly recommend to:

• Avoid lightweight tags by specifying a message for the tag, ideally formatted like so: New stable version vX.X.X.
• Create a Gitlab release when you push a new version tag, and to copy the relevant content of your CHANGELOG.md into the release notes section.