AuraDeck

Advanced

Contributing

How to file issues, propose changes, and get a PR merged.

Thanks for your interest in improving AuraDeck. The project is small and the contribution process is informal — there is no CLA, no required template, and no committee.

Filing issues

Open issues on the GitHub tracker. Useful issues usually include:

  • The platform you are on (OS + version, AuraDeck commit / build date).
  • The exact steps to reproduce the bug.
  • What you expected vs. what happened.
  • For visual bugs, a screenshot or short screen recording.

Feature requests are welcome too — say what you want to do and what you have tried as a workaround.

Submitting a pull request

  1. Fork the repo and branch from main.
  2. Make your change. Try to keep the diff focused — one PR, one concern.
  3. Run npm run tauri dev and verify the change works locally.
  4. Open the PR with a short description of what changed and why.

There is no required commit message format and no required CI yet. Be excellent to the maintainer and they will be excellent back.

Code style

  • JavaScript: 2-space indent, semicolons, ES modules, no transpilation.
  • Rust: standard rustfmt formatting (cargo fmt).
  • CSS: 2-space indent, no preprocessor, custom-properties for theme values.

If a file already follows a different style, match the file rather than the project — internal consistency beats project-wide consistency.

Building from source

See Installation for prerequisites and the basic npm run tauri dev workflow. For release builds:

npm run tauri build

The output binary lives in src-tauri/target/release/auradeck. On Linux, follow the install script to register it with your desktop.

Roadmap

The current priorities, roughly in order:

  1. Headless auradeck export subcommand for CI-based PDF rendering.
  2. Pre-built release binaries for macOS, Windows, and Linux (via GitHub Releases).
  3. Custom transition library beyond the four built-in transitions.
  4. Optional speaker-notes-only PDF export.
  5. Theme presets that ship with the app.

The unstructured to.do file in the repo root is the canonical source for known issues and small enhancements. Feel free to pick something off it.

License

AuraDeck is MIT licensed. Contributions are accepted under the same license — by submitting a PR you agree your changes can be redistributed under the MIT License.

Source on GitHub ↗