Contributing

Contributing

Contributions are welcome. This page is a quick orientation; the authoritative coding standards live in CONTRIBUTING.md.

Workflow

1. Fork the repository and create a topic branch off master.
2. Make your change, keeping it focused — one logical change per pull request.
3. Build for at least one target and, where possible, test on real hardware.
4. Open a pull request. The PR template will prompt you for testing details.

Code style

• Indentation: tabs, not spaces
• Braces: opening brace on its own line (non-K&R)
• Shell scripts: POSIX sh
• Keep unrelated changes out of the pull request
• When you change UI text, add or update the matching i18n strings

Where to put things

Gargoyle's web UI and backend scripts live under package/gargoyle/ and the various package/plugin-gargoyle-* packages. Per-language UI strings live under the plugin-gargoyle-i18n-* packages.

Getting help

• Discussions for design questions and ideas
• Issues for reproducible bugs
• The community site for general project info