Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (57 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

91 lines (57 loc) · 4.06 KB

Contributing to Ropy

English | 简体中文

Thank you for considering contributing to Ropy! This document will guide you through adding new themes and language support to the project.

Release

Releases are managed by cargo-release. Run scripts/update_version.sh to trigger the flow:

scripts/update_version.sh patch                   # dry-run a patch bump
scripts/update_version.sh 0.6.0 --execute         # release 0.6.0
scripts/update_version.sh 0.6.0-beta --execute    # pre-release

The release pipeline (cargo release) automatically:

  1. Bumps the version in Cargo.toml [package].
  2. Syncs the version to [package.metadata.bundle.bin.ropy] via pre-release-replacements.
  3. Runs scripts/release_prepare.sh (pre-release hook) which executes precheck.sh, record_build_size.sh, generates the changelog with git-cliff, and verifies dist plan.
  4. Commits, tags, and pushes — triggering the GitHub Actions release workflow.

Adding a New Theme

Ropy uses TOML configuration files to define themes. Theme files are located in the assets/themes/ directory.

Steps

  1. Create a Theme File

    Create a new .toml file in the assets/themes/ directory. The filename (without extension) becomes the theme ID. Use lowercase letters and hyphens (e.g., my-theme.toml).

  2. Define Theme Content

    The theme file must include theme_name, mode (light or dark), and a full set of color fields (hexadecimal values). Refer to assets/themes/ropy-dark.toml for the complete field list and expected format.

Examples

Refer to existing theme files:

  • assets/themes/ropy-dark.toml - Dark theme example
  • assets/themes/ropy-light.toml - Light theme example
  • assets/themes/nord-light.toml - Nord color scheme example
  • assets/themes/everforest-night.toml - Everforest color scheme example

Adding a New Language

Ropy supports internationalization (i18n). Language files also use TOML format and are located in the assets/locales/ directory.

Steps

  1. Create a Language File

    Create a new .toml file in the assets/locales/ directory. The filename should use the language code (e.g., fr.toml for French, ko.toml for Korean).

    Language codes should follow the BCP 47 standard:

    • For regional variants, use {language-code}-{region-code} format, e.g.:
      • zh-CN - Simplified Chinese
      • zh-TW - Traditional Chinese (Taiwan)
      • pt-BR - Brazilian Portuguese

  2. Define Language Content

    The first line of the language file should contain the language_name field (written in the language itself) for display in settings. Refer to assets/locales/en.toml for the full structure and all translation keys.

Translation Tips

  1. Keep it concise: UI space is limited, use compact expressions
  2. Maintain consistency: Use the same translation for the same concept
  3. Respect user habits: Use expressions natural to target language speakers
  4. Test the display: Launch the application to verify translations in the actual interface

Examples

Refer to existing language files:

  • assets/locales/en.toml - English (base language)
  • assets/locales/zh-CN.toml - Simplified Chinese
  • assets/locales/ja.toml - Japanese

Testing

See the Testing Documentation for guidelines on writing and running tests.

Submitting Changes

Ropy follows an Issue → Branch → PR → Squash Merge workflow, executed via the local gh CLI. The complete, copy-paste-ready SOP lives in the contribution-flow skill — it is the single source of truth for branch naming, commit conventions, the scripts/precheck.sh gate, and the PR self-check. Both human and AI contributors should follow it.

Reporting Issues

If you find a bug or have a feature suggestion, please submit it on the Issues page using the matching template.

Thank you for your contribution!