瀏覽代碼

Add Contribution doc

Neeraj Gupta 1 年之前
父節點
當前提交
c413564a4b
共有 3 個文件被更改,包括 74 次插入31 次删除
  1. 1 1
      .github/workflows/ci.yml
  2. 56 0
      CONTRIBUTING.md
  3. 17 30
      README.md

+ 1 - 1
.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Flutter CI
+name: release
 
 
 # This workflow is triggered on pushes to the repository.
 # This workflow is triggered on pushes to the repository.
 on:
 on:

+ 56 - 0
CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# 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
+[![Crowdin](https://badges.crowdin.net/ente-authenticator-app/localized.svg)](https://crowdin.com/project/ente-authenticator-app)
+
+We use [Crowdin](https://crowdin.com/project/ente-authenticator-app) to crowdsource
+translations of ente Authenticator. 
+If your language is not listed for translation, feel free to [create a GitHub issue](https://github.com/ente-io/auth/issues/new?title=Request+for+New+Language+Translation&body=Language+name%3A) to have it added.
+
+## Icons
+
+ente Auth supports the icon pack provided by
+[simple-icons](https://github.com/simple-icons/simple-icons).
+
+If you would like to add your own custom icon, please open a pull-request
+with the relevant SVG and color
+code ([example PR](https://github.com/ente-io/auth/pull/213/files)).
+
+
+## Developement
+
+If you're planning on adding a new feature or making other changes, please
+discuss it with us by creating [an
+issue](https://github.com/ente-io/auth/issues/new)
+on GitHub. Discussing your idea with us first ensures that everyone is on the
+same page before you start working on your change.
+
+### 💻  Setup
+
+1. [Install Flutter v3.10.6](https://flutter.dev/docs/get-started/install)
+2. Clone this repository with `git clone git@github.com:ente-io/auth.git` 
+3. Pull in all submodules with `git submodule update --init --recursive`
+4. For Android, run 
+    ```bash
+    flutter run -t lib/main.dart --flavor independent
+    ```
+5. For iOS, run `flutter run` 
+
+
+#### Localization
+If the feature works require adding new strings, you can do that by following these steps.
+
+1. Add a new entry inside [app_en.arb](https://github.com/ente-io/auth/blob/main/lib/l10n/arb/app_en.arb) (Remember to save)
+2.  In your dart file, add follwing import
+    ```dart
+    import "package:ente_auth/l10n/l10n.dart";
+    ```
+3. Refer to the string using `context.l10n.<keyName>`. For example 
+    ```dart
+    context.l10n.account
+    ```

+ 17 - 30
README.md

@@ -1,5 +1,9 @@
 # ente Authenticator
 # ente Authenticator
 
 
+![Build](https://github.com/ente-io/auth/actions/workflows/ci.yml/badge.svg?branch=)
+[![Crowdin](https://badges.crowdin.net/ente-authenticator-app/localized.svg)](https://crowdin.com/project/ente-authenticator-app) 
+ [![Matrix](https://img.shields.io/matrix/ente:matrix.org?color=blue)](https://matrix.to/#/#ente:matrix.org)
+
 ente's Authenticator app helps you generate and store 2 step verification (2FA)
 ente's Authenticator app helps you generate and store 2 step verification (2FA)
 tokens on your mobile devices.
 tokens on your mobile devices.
 
 
@@ -32,15 +36,12 @@ the way of your workflow.
 You can add tokens to ente by one of the following methods:
 You can add tokens to ente by one of the following methods:
 1. Scanning a QR code
 1. Scanning a QR code
 2. Manually entering (copy-pasting) a 2FA secret
 2. Manually entering (copy-pasting) a 2FA secret
-3. Bulk importing from a file that contains a list of codes in the following
-   format:
-```
-otpauth://totp/provider.com:you@email.com?secret=YOUR_SECRET
-```
-The codes maybe separated by new lines or commas.
+3. Bulk importing from other popular 2FA apps and from a file  that contains a list of codes in the following format:.
+    ```
+    otpauth://totp/provider.com:you@email.com?secret=YOUR_SECRET
+    ```
 
 
-You can also export the codes you have added to ente, to an **unencrypted** text
-file, that adheres to the above format.
+You can export the codes you have added to ente, to either an **encrypted** or plain text file. 
 
 
 
 
 ## 📲 Download
 ## 📲 Download
@@ -71,16 +72,10 @@ src="https://ente.io/static/ed265c3abdcd3efa5e29f64b927bcb44/e230a/play-store-ba
 src="https://user-images.githubusercontent.com/1161789/154795157-c4468ff9-97fd-46f3-87fe-dca789d8733a.png">
 src="https://user-images.githubusercontent.com/1161789/154795157-c4468ff9-97fd-46f3-87fe-dca789d8733a.png">
 </a>
 </a>
 
 
-### Web
+### Web / Desktop
 
 
 You can view your 2FA codes at [auth.ente.io](https://auth.ente.io). For adding or managing your secrets, please use our mobile app.
 You can view your 2FA codes at [auth.ente.io](https://auth.ente.io). For adding or managing your secrets, please use our mobile app.
 
 
-### Desktop
-
-Support for desktop platforms (Linux, Windows and older Macs) is a [work in
-progress](https://github.com/ente-io/auth/tree/desktop).
-
-Please ⭐ this repo to be notified of updates.
 
 
 
 
 ## 🔩 Architecture
 ## 🔩 Architecture
@@ -88,6 +83,12 @@ Please ⭐ this repo to be notified of updates.
 The architecture that powers end-to-end encrypted storage and sync of your
 The architecture that powers end-to-end encrypted storage and sync of your
 tokens has been documented [here](architecture/README.md).
 tokens has been documented [here](architecture/README.md).
 
 
+## 🧑‍💻 Contribute
+
+Please refer to the [contribution guide](./CONTRIBUTING.md) if you wish to add an icon, assist with translation, or develop new features.
+
+You can also support us by giving this project a ⭐ star on GitHub or by leaving a review on [PlayStore](https://play.google.com/store/apps/details?id=io.ente.auth), [AppStore](https://apps.apple.com/us/app/ente-authenticator/id6444121398) or [AlternativeTo](https://alternativeto.net/software/ente-authenticator/).
+
 
 
 ## 🧑‍💻 Building from source
 ## 🧑‍💻 Building from source
 
 
@@ -101,29 +102,15 @@ For maintainers, there is [additional documentation](RELEASES.md) on
 automatically publishing the main branch to App store, Play store and GitHub
 automatically publishing the main branch to App store, Play store and GitHub
 releases.
 releases.
 
 
-## 🙂 Icons
-
-ente Auth supports the icon pack provided by
-[simple-icons](https://github.com/simple-icons/simple-icons).
 
 
-If you would like to add your own custom icon, please open a pull-request
-with the relevant SVG and color
-code ([example PR](https://github.com/ente-io/auth/pull/213/files)).
-
-## 🙋‍♂️ Support
+## 🙋‍♂️ Help
 
 
 If you need help, please reach out to support@ente.io, and a human will get in
 If you need help, please reach out to support@ente.io, and a human will get in
 touch with you.
 touch with you.
 
 
 If you have feature requests, please create a [GitHub issue](https://github.com/ente-io/auth/issues/).
 If you have feature requests, please create a [GitHub issue](https://github.com/ente-io/auth/issues/).
 
 
-If you wish to support us, please ⭐
-[star](https://github.com/ente-io/auth/stargazers) this project.
-
-## 🙌 Translation
-[![Crowdin](https://badges.crowdin.net/ente-authenticator-app/localized.svg)](https://crowdin.com/project/ente-authenticator-app)
 
 
-If you're interested in helping out with translation, please visit our [Crowdin project](https://crowdin.com/project/ente-authenticator-app) to get started. Thank you for your support.
 
 
 ## 💜 Community
 ## 💜 Community