Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 1.18 KB
Raw

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

  • If you want to contribute first you need to check the issues, them 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)

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 🔠

How to

  1. Fork this repository
  2. Clone it
  3. Work on your translations (located in frontend/src/lib/i18n)
  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 & also for your interest on contributing