Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.78 KB

File metadata and controls

52 lines (35 loc) · 1.78 KB

Contributing to Afterthought

Thanks for contributing.

Before You Start

  • Check existing issues and discussions before starting larger work.
  • Keep changes focused. Separate refactors from behavior changes where possible.
  • For non-trivial work, trace the affected flow before editing. This app often crosses React, Tauri commands, Rust services, and SQLite.

Local Setup

npm install
cd src-tauri && cargo generate-lockfile
npm run tauri:dev

See docs/DEVELOPMENT.md for platform prerequisites and change recipes.

Pull Requests

  • Describe the user-visible change and why it is needed.
  • Call out any schema, settings, watcher, search, AI, or snipping changes explicitly.
  • Update docs in the same pull request when setup or behavior changes.
  • Keep commits intentional and easy to review.

Validation

Run the smallest relevant checks while iterating. Before asking for review on substantial changes, run:

npm run build
cd src-tauri && cargo test
cd src-tauri && cargo fmt -- --check
cd src-tauri && cargo clippy -- -D warnings

If you changed watcher, AI, onboarding, settings, search, or snipping flows, also smoke-test the app with npm run tauri:dev.

Code Style

  • Keep the Tauri command boundary in src-tauri/src/commands.rs.
  • Keep shared frontend and backend types aligned.
  • Treat src-tauri/src/db.rs as the runtime schema source of truth.
  • Do not commit local artifacts, generated build output, or personal tooling settings.

Community

By participating, you agree to follow CODE_OF_CONDUCT.md.

For security-sensitive issues, follow SECURITY.md instead of opening a public issue.