-
Notifications
You must be signed in to change notification settings - Fork 36
Contribute
The easiest way to contribute is to report every error you encounter. Ideas for future enhancements are also welcome.
Another good way is to contribute to be default sign rules and the included favicon list. Or you could help translate the add-on to make it more accessible for other users.
Below you find more detailed information about the different ways you can help improve the add-on:
You would like to see a domain being included in the default sign-rules or an icon be shown for it?
You can contribute to the sign-rules and favicons by:
- Creating a pull request there you add the rule and favicon yourself if you feel comfortable doing so.
- Opening an issue with the relevant information.
- Sending the relevant information via e-mail.
Please also report any issue you find with an existing sign-rules or favicon.
A domains must have a certain relevance to be added. This is the case for pretty much any domain related to a company or organization.
Favicon were added so that the user can directly link the sender of an e-mail to e.g. a company, without necessarily needing to carefully check the signing domain and from address.
To achieve this the following additional criteria need to be met:
-
A usable and recognizable icon must exit. This should be the case for most domains that have a favicon.
The icon must be square. The preferred format is SVG, but other formats supported by Thunderbird like e.g. ICO and PNG are OK too. Try to use an icon that is under 5 KiB. In most cases 32x32 px is a good compromise between size and visible details.
-
The signing domain (SDID) must be connected to the domain of the From address.
This is often not the case for newsletters that are only signed by a general domain of a third party newsletter sender. Note that a favicon can be added if the SDID of the third party includes the From domain as a sub-domain.
-
All e-mails with user generated contend must be easily identified as such, so it can not be confused with other official e-mails from the same domain.
This means the complete domain of e-mail providers will not be added. But e.g. the notifications GitHub is sending are not a problem.
For domains that are not eligible or there it is not desired to add the favicon for the complete domain, the favicon can be added for specific from addresses or AUIDs.
The following information is needed:
- The From address. If the local part (the one before the
@) contains personal information you can omit it. - The signing domain (SDID).
- Did you receive other e-mails from the same base domain which there not signed or signed by another SDID? If yes please provide the From address and SDID (if signed) for it too.
- Optional for favicon: URL to a usable icon.
In case you are interested in providing a new translation or improving an existing one, you can do this by creating a pull request here on GitHub. More information about localization can be found in the _locales/Readme.md file.
Current status of the translations:
| Language | Status | Maintainer |
|---|---|---|
| de (German) | active | @lieser |
| en_US | reference | @lieser |
| es_ES (Spanish) | inactive since 4.1.0 | - |
| fr (French) | active | @AnaelMobilia |
| hu (Hungarian) | inactive since 5.0.0 | - |
| it (Italian) | active | @mlocati |
| ja_JP (Japanese) | active | @kenichisak |
| pl (Polish) | active | @dMbski |
| pt_BR (Brazilian Portuguese) | inactive since 5.0.0 | - |
| sv_SE | inactive, incomplete | - |
| uk (Ukrainian) | active | @lexxai |
| zh_CN | inactive since 4.0.0 | - |
| zh_TW (Traditional Chinese) | active | @NightFeather |
Feel free to fix bugs or add futures yourself by creating a pull request. For bigger changes best contact me first for better coordination.
The readme of the repository contains some information about the code structure. A more detailed development guide is currently unfortunately not available. But if you have any questions don't hesitate to ask.
General documentation about developing Thunderbird add-ons can be found in https://developer.thunderbird.net/add-ons/about-add-ons.