Skip to content

Latest commit

 

History

History
28 lines (14 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

28 lines (14 loc) · 2.52 KB

Welcome

We invite you to join our team! Everyone is welcome to contribute code via pull requests and filing issues on GitHub. You can contribute in different ways. Do you think you are not capable to contribute? I will prove you are wrong. Let's get started!

Translating the app

Right now the app is translated in several languages. If you know other languages and wants to help internationalizing take a look at the most updated instruction here. Than, if you want you can also translate the PlayStore/F-droid app page. You can find the page to translate here. If you have some question please contact me via e-mail or submit a new issue. That's all, I will take care of the rest. Thank you!

Design a new logo

If you think you are able to do a better app icon you are welcome to open a new issue with your proposal. Than I can tell you how you can merge you idea to this project. Thank you!

Submit a PR

If you feel confident with Flutter coding, you can help me improving this app by submitting a PR. But first, let me explain you how this project is organized.

Project structure

The project uses provider for state management and it helps separate the UI from the model. Right now there are two models: AppModel.dart contains the basic logic of the app (which page is selected, in which order, etc.) and Conversions.dart contains the logic of the conversion section (retrieve currencies rates from the Internet, in which order are the units of measurement, etc.). The app is structured as a monorepo and it is managed with melos.

Add new units

If you want to add new units I wrote a wiki page, it is a step by step guide.

What if I am too lazy?

You should exit from your comfort zone and find out what it feels to submit a PR and merge it to an open source project! When you do it you feel like a little bit of this project is also yours and all the people that use this app will enjoy your contributions! But if you are too too lazy you can contribute with a small PayPal donation to let the developer see your interest. Thank you!