Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.41 KB
Raw

Contributing

Bug report

For now GitHub Bug Traker is used for this project.

Development

  • The stable Rust programming language is used mainly in this project.
  • Dependencies managment handled using Cargo.
  • Building handled using Meson

Style

  • You should document every thing to keep the code easy for reading. Every file, every function and any line that need a comment.

Setup pre-commit

To make every thing easy pre-commit is used in this project, it should run in every commit, so you shouldn't commit any thing without checking it.

First install it:

pip install pre-commit

It's better to use you OS's package manager to install it.

Then add it as a git hook while you are inside the repository:

pre-commit install

Translation

We use gettext in this project, you have .po files to translate and a .desktop file.

Files to Translate

  • po/<language_id>.po
  • io.github.zefr0x.ianny.desktop

Adding New Language

  1. Copy po/io.github.zefr0x.ianny.pot to po/<language_id>.po.
  2. Add the language ID to the po/LINGUAS file (IDs are separated by space).
  3. Start editing the .po file using any editor you want to use (e.g. Gtranslator).