Contributing

Thank you for showing interest in contributing to ente Authenticator. There are a couple of ways to help out. This document contains some general guidelines for each type of contribution.

Translations

We use Crowdin to crowdsource translations of ente Authenticator. If your language is not listed for translation, feel free to create a GitHub issue to have it added.

Icons

ente Auth supports the icon pack provided by simple-icons.

If you would like to add your own custom icon, please open a pull-request with the relevant SVG placed within assets/custom-icons/icons and add the corresponding entry within assets/custom-icons/_data/custom-icons.json.

This JSON file contains the following attributes:

Attribute	Usecase	Required
`title`	Name of the service.	Yes
`slug`	If the icon's SVG file has a name different from the `title`	No
`hex`	Color code for the icon	No
`altNames`	If the same service goes by different names or has different instances (eg. Mastodon)	No

Here is an example PR.

Development

If you're planning on adding a new feature or making other changes, please discuss it with us by creating an issue on GitHub. Discussing your idea with us first ensures that everyone is on the same page before you start working on your change.

Setup

Install Flutter v3.10.6
Clone this repository with git clone git@github.com:ente-io/auth.git
Pull in all submodules with git submodule update --init --recursive

For Android, run

flutter run -t lib/main.dart --flavor independent

For iOS, run flutter run

Localization

If the feature requires adding new strings, you can do that by following these steps:

Add a new entry inside app_en.arb (Remember to save)

In your dart file, add follwing import

import "package:ente_auth/l10n/l10n.dart";

Refer to the string using context.l10n.<keyName>. For example
```
context.l10n.account
```

2.5 KiB Raw Blame History