Updated Contribution Guide + Removed Icons

I have updated the contribution guide to include what I believe are appropriate icon requirements. I have also removed icons that all use a single-sign on account and moved them to a different folder as I'm unsure what you would prefer to do with these.
stratumauth · Jun 3, 2022 · aa869a8 · aa869a8
1 parent a9365ed
commit aa869a8
Show file tree

Hide file tree

Showing 36 changed files with 17 additions and 5 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,13 +1,23 @@
 # Contribution Guide 
 
-## Translations
+## Translations 💬
 
 Translations are now managed on Crowdin. Go to the [Authenticator Pro Crowdin project](https://crwd.in/authenticator-pro) to contribute. If your language is not available, please contact me and I will add it.
+<br></br>
 
-## Icons
+## Icons ⏺️
 
-If you'd like to contribute some icons, check the [missing icons list](./extra/missing_icons.txt) for some that might need adding. They may already exist, so check first!
+If you'd like to contribute some icons, first check if there's [any open issues from user requests](https://github.com/jamie-mh/AuthenticatorPro/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). Alternatively take a look at the [missing_icons.txt file](./extra/missing_icons.txt). Keep in mind some the the services listed here may already have an icon or not meet the criteria to get one so make sure to check first.
 
+### Icon criteria:
+Not every service needs an icon. To prevent the app having hundreds of icons from obscure and rarely used platforms, we limit what icons can be added. If a service doesn't meet the criteria we encourage the use of custom icons from within the app.
+
+- Platforms that use a 'Single Sign-On' should have the icon added for the sign-on account and not for the individual platforms. Eg: instead of a YouTube icon a Google icon would be needed, or instead of a Photoshop icon an Adobe icon should be used.
+- Web based platforms should be within [Similarweb's](https://www.similarweb.com) top 200,000 global rank. [Simply search for the site and see for yourself](https://www.similarweb.com).
+- Mobile platforms should have at least 100k+ downloads on the [Google Play Store](https://play.google.com/). 
+- If the service is not web based or on the Play Store it will have to be reviewed individually, in which case it's best to just [submit a request as a issue.](https://github.com/jamie-mh/AuthenticatorPro/issues/new?assignees=&labels=enhancement&template=icon_request.md&title=)
+
+### How to add an icon:
 To add an icon to the project the procedure is as follows:
 
 * Fork the repo
@@ -35,7 +45,8 @@ To add an icon to the project the procedure is as follows:
 * Commit your changes
 
 * Create a pull request with your changes
+<br></br>
 
-## Code / Features
+## Code / Features ⚙️
 
 Before submitting any code, please open an issue to discuss if the feature is relevant.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ Authenticator Pro is currently only available on the F-Droid client through the
 [Contribution Guide](https://github.com/jamie-mh/AuthenticatorPro/blob/master/CONTRIBUTING.md)
 
 [Backup File Format](https://github.com/jamie-mh/AuthenticatorPro/blob/master/doc/BACKUP_FORMAT.md)
+<br/><br/>
 
 ### Importing from other apps:
 
@@ -94,7 +95,7 @@ Authenticator Pro has a beautiful material design inspired look in either light
 ![Screenshot 8](./doc/screenshot8.png)
 <br/><br/>
 
-## Wear OS Companion
+### Wear OS Companion
 
 ![Screenshot 1](./doc/wearos_screenshot1.png)
 ![Screenshot 2](./doc/wearos_screenshot2.png)

diff --git a/icons/amazonpay.png → extraicons/amazonpay.png b/icons/amazonpay.png → extraicons/amazonpay.png
diff --git a/icons/amazonpay_dark.png → extraicons/amazonpay_dark.png b/icons/amazonpay_dark.png → extraicons/amazonpay_dark.png
diff --git a/icons/azure.png → extraicons/azure.png b/icons/azure.png → extraicons/azure.png
diff --git a/icons/bitbucket.png → extraicons/bitbucket.png b/icons/bitbucket.png → extraicons/bitbucket.png
diff --git a/icons/confluence.png → extraicons/confluence.png b/icons/confluence.png → extraicons/confluence.png
diff --git a/icons/gmail.png → extraicons/gmail.png b/icons/gmail.png → extraicons/gmail.png
diff --git a/icons/googlecloud.png → extraicons/googlecloud.png b/icons/googlecloud.png → extraicons/googlecloud.png
diff --git a/icons/googledrive.png → extraicons/googledrive.png b/icons/googledrive.png → extraicons/googledrive.png
diff --git a/icons/googlefi.png → extraicons/googlefi.png b/icons/googlefi.png → extraicons/googlefi.png
diff --git a/icons/googlefiber.png → extraicons/googlefiber.png b/icons/googlefiber.png → extraicons/googlefiber.png
diff --git a/icons/googlefit.png → extraicons/googlefit.png b/icons/googlefit.png → extraicons/googlefit.png
diff --git a/icons/googlepay.png → extraicons/googlepay.png b/icons/googlepay.png → extraicons/googlepay.png
diff --git a/icons/googleplay.png → extraicons/googleplay.png b/icons/googleplay.png → extraicons/googleplay.png
diff --git a/icons/jira.png → extraicons/jira.png b/icons/jira.png → extraicons/jira.png
diff --git a/icons/jiraservicedesk.png → extraicons/jiraservicedesk.png b/icons/jiraservicedesk.png → extraicons/jiraservicedesk.png
diff --git a/icons/nordlocker.png → extraicons/nordlocker.png b/icons/nordlocker.png → extraicons/nordlocker.png
diff --git a/icons/nordpass.png → extraicons/nordpass.png b/icons/nordpass.png → extraicons/nordpass.png
diff --git a/icons/office.png → extraicons/office.png b/icons/office.png → extraicons/office.png
diff --git a/icons/onedrive.png → extraicons/onedrive.png b/icons/onedrive.png → extraicons/onedrive.png
diff --git a/icons/opsgenie.png → extraicons/opsgenie.png b/icons/opsgenie.png → extraicons/opsgenie.png
diff --git a/icons/outlook.png → extraicons/outlook.png b/icons/outlook.png → extraicons/outlook.png
diff --git a/extraicons/protonmail.png b/extraicons/protonmail.png
diff --git a/extraicons/protonvpn.png b/extraicons/protonvpn.png
diff --git a/icons/skype.png → extraicons/skype.png b/icons/skype.png → extraicons/skype.png
diff --git a/icons/statuspage.png → extraicons/statuspage.png b/icons/statuspage.png → extraicons/statuspage.png
diff --git a/icons/trello.png → extraicons/trello.png b/icons/trello.png → extraicons/trello.png
diff --git a/icons/visualstudioonline.png → extraicons/visualstudioonline.png b/icons/visualstudioonline.png → extraicons/visualstudioonline.png
diff --git a/icons/xbox.png → extraicons/xbox.png b/icons/xbox.png → extraicons/xbox.png
diff --git a/icons/xbox_dark.png → extraicons/xbox_dark.png b/icons/xbox_dark.png → extraicons/xbox_dark.png
diff --git a/icons/youtube.png → extraicons/youtube.png b/icons/youtube.png → extraicons/youtube.png
diff --git a/icons/nordvpn.png → icons/nord.png b/icons/nordvpn.png → icons/nord.png
diff --git a/icons/proton.png b/icons/proton.png
diff --git a/icons/protonmail.png b/icons/protonmail.png
diff --git a/icons/protonvpn.png b/icons/protonvpn.png