Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rough rudimentary CONTRIBUTING.md #753

Merged
merged 10 commits into from
Jun 19, 2023
Next Next commit
Add rough rudimentary CONTRIBUTING.md
MV-GH committed Jun 19, 2023
commit b9edfb3938bb9c24dc4981aa00dc53ff1825807a
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to Jerboa

<!-- TOC -->
* [Contributing to Jerboa](#contributing-to-jerboa)
* [Ways to contribute](#ways-to-contribute)
* [Application structure](#application-structure)
* [Code contributions](#code-contributions)
* [Kotlin](#kotlin)
* [Code quality](#code-quality)
* [Adding translations](#adding-translations)
<!-- TOC -->

## Ways to contribute
- Participate here and start answering questions.
- File GitHub issues for big reports from /c/Jerboa. Watch the project for duplicate reports and link them to the first report so devs can easily close dupes.
- File new bug reports for issues you find.
- Add missing translations
- Code contributions

## Application structure
- Basic Modern Android Development (https://developer.android.com/series/mad-skills) tech stack (Compose, Navigation, Coroutines, AndroidX)
- Guide to App Architecture (https://developer.android.com/topic/architecture), without domain layer. Basically, MVVM + Repositories for data access.
- Manual DI

## Code contributions
You can open Jerboa in AndroidStudio.

### Kotlin
This project is full Kotlin. Please do not write Java classes.

### Code quality
The code must be formatted to a common standard.

To check for violations
`./gradlew lintKotlin`
Or just run this to fix them
`./gradlew formatKotlin`

## Adding translations
You can find the translations in the `app/src/main/res/values-{locale}/strings.xml` file.
You can open it in android studio, right click and click open translations editor or you can directly edit the files.