Contributing
Ways to Contribute
Where each kind of contribution goes — plugins, themes, sniffing rules, translations, docs and code — and which public repository to use.
Edit this pageFluxDown is developed in the open across a few public GitHub repositories. Each kind of contribution has its own home and its own workflow — find the row that matches what you want to share.
| You want to share | Repository | How it gets in | Guide |
|---|---|---|---|
| A plugin (resolver, hook, view) | zerx-lab/fluxdown-plugin-index | Register your own plugin repository once; every later GitHub Release is picked up automatically | Publishing Plugins |
| A theme | zerx-lab/fluxdown-themes | Pull request with the theme files and screenshots; CI validates, a maintainer reviews | Submitting Themes |
| A sniffing rule for the browser extension | zerx-lab/fluxdown-sniff-rules | Your own rule repository (registered once) or a one-off Issue form | Contributing Sniffing Rules |
| A translation | zerx-lab/FluxDown | Pull request against main | Translating FluxDown |
| A docs fix or a code change | zerx-lab/FluxDown | Pull request against main | Contributing to the Docs |
Tools for contributors
- Plugin SDK —
fluxdown-plugin-sdkon npm: typedflux.*APIs, a JSX runtime for views, the manifest validator used by the engine and the plugin index, and a CLI that packs.fxplugfiles. Its source ispackages/plugin-sdkin the main repository; usage is covered in Plugin SDK & CLI. - Theme Builder — the Theme Builder edits every theme token against a live preview of the desktop client and exports theme JSON.
- Rule repository template — zerx-lab/fluxdown-sniff-rules-template starts your own sniffing-rule repository with the self-check workflow already set up.
Other ways to help
- Report bugs and request features on the feedback page or in GitHub Issues.
- Vote on what gets built next on the feature vote page.
- Every docs page has an Edit this page link and a feedback form at the bottom.
Good to know
- In the main repository, open pull requests against
main— it is the development branch;stableonly tracks stable releases. - Contributions are accepted under the license of the repository you contribute to; the main repository is AGPL-3.0.
- Plugin and sniffing-rule authors keep their work in their own repositories. The index repositories only register them, so you stay in control of your release pace.