Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

57 lines (34 loc) · 2.25 KB

Contributing

Contributions are welcome! Please follow the guidelines below to contribute to the project.

Getting Started

The development environment is managed using devenv.
If you don't have devenv installed, follow the instructions here.

Development

To start the Tauri development window:

dev-desktop

The first time you run this command, the Rust package manager will take several minutes to download and build all the required packages. Subsequent builds will be much faster due to caching.

Once Rust has finished building, the webview will open, displaying your web app. Changes to the web app should update automatically, similar to a browser. When you update your Rust files, they are rebuilt automatically, and your app will restart.

Recommended IDE Setup

Style Guide

React Functional Components

  • Component Folder: Create a new folder for each component. Name the folder using the component's name in lowercase, separated by hyphens (e.g., add-filter-dialog).

    • Component File: Inside the folder, create a file for the component. Name the file using PascalCase, followed by .tsx (e.g., AddFilterDialog.tsx). Export only the component from this file.

    • Styles File: If the component has custom styles, create a styles file named in PascalCase, followed by .module.scss (e.g., AddFilterDialog.module.scss).

  • Props Types: If the component has any props, create a type for the props. Name the type using PascalCase, followed by Props (e.g., AddFilterDialogProps).

  • Inline Functions: Use inline functions whenever possible to reduce complexity and improve readability.

  • JSDoc Comments: Create JSDoc comments for all functions, including:

    • @param for each parameter
    • @returns for the return value
    • @throws for any errors that can be thrown
    • @example for an example of usage

Building

To build the Tauri app:

build

Icons