Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.23 KB

File metadata and controls

48 lines (35 loc) · 2.23 KB

Contributing

Structure of the project

  • src/ (Golang / Wails)
  • frontend/ ( Typescript / Sveltekit - All the UI for the Desktop APP & the Web version)
  • docs/ (All the development documentation)
  • frontend/src/lib/i18n (All the translations of the project)

Requisites (only apply to code contributions)

  • If you want to contribute first you need to check the issues, then if you like any of the open issues work on it and merge it to the project. Obviously you can open a new issue to enhance the features or correct any bug you found to work on it later.
  • Try to do self-explanatory code. If cannot be you can comment to enhance the comprehension.
  • No AI (Vibe-coding): If you try to submit code that it was made by AI simply don't do it. This project is written by humans for humans. If there are any evidence of Claude / Cursor / Antigravity / Copilot / ... the pull request will be rejected.

Resources of interest

How to

  1. Fork this repository
  2. Clone it
  3. Work on the issue
  4. When you have finished make a pull request to merge it with the main branch
  5. Wait for merge (maybe it will not be merged at first because of bad code)
  6. Done

Translations 🔠

By default English is the language of reference so you can check if there are entries in english that are missing in the language you may want to contribute to

How to

  1. Fork this repository
  2. Clone it
  3. Work on your translations (located in frontend/src/lib/i18n):
    • Create a JSON file of the language and register the language in the i18n.ts file (all of this if the language is not added already)
    • Add the entries (you can do manually but using i18n Ally extension is recommended)
  4. When you have finished make a pull request to merge it with the main branch
  5. Wait for merge
  6. Done

Thank You for Reading This and for Your Interest on Contributing