add CONTRIBUTING.md with information on translations, esp. alias translations

Author: supersaiyansubtlety

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing
+
+Thank you for your interest in contributing to Enigma!
+
+We recommend discussing your contribution with other members of the community - either directly in your pull request,
+or in our other community spaces. We're always happy to help if you need us!
+
+Enigma is distributed under the [LGPL-3.0](LICENSE).
+
+## Translating
+Translations are loaded from [enigma/src/main/resources/lang/](enigma/src/main/resources/lang/).
+
+These are the currently supported languages and their corresponding files:
+
+| Language                   | File         |
+|----------------------------|--------------|
+| English (U.S.) **default** | `en_us.json` |
+| Chinese (Simplified)       | `zh_cn.json` |
+| French                     | `fr_fr.json` |
+| German                     | `de_de.json` |
+| Japanese                   | `ja_jp.json` |
+
+If a language you'd like to translate isn't on the list, feel free to ask for help on
+[Quilt's Discord Server](https://discord.quiltmc.org/)!
+
+### Search Aliases
+Many elements in Enigma's GUI support search aliases, but most don't have any aliases.
+A full list of search alias translation keys is [below](#complete-list-of-search-alias-translation-keys).
+Search aliases are alternative names for an element that a user might search for when looking for that element.
+For example, the `Dev` menu element has two search aliases: `"Development"` and `"Debugging"`. This means that if a user
+searches for "Debug", the `Dev` menu will be a search result.
+
+Search aliases are language-specific, so there's no need to translate the English aliases if they aren't likely
+to be searched for in your target language. In fact, any language may add additional aliases that aren't present in the
+English translation.
+
+Since elements can have multiple search aliases, their translations can be lists. Aliases are separated by `;`.<br>
+For example, the `Dev` menu's aliases look like this in the translation file: `"Development;Debugging"`
+This means that aliases may not contain the `;` character.
+
+Some things to keep in mind when adding search aliases:
+- elements' names are always searchable; there's no need to add their names to their aliases
+- searching is case-insensitive, so there's no need to add variations that only differ in capitalization
+- searching matches prefixes, so there's no need to add variations that are prefixes of one another,
+just add the longest variation (note that the element name may be a prefix of an alias, as is the case with `Dev`'s
+`"Development"` alias)
+
+If you'd like to add search aliases to an element that doesn't already have aliases, add its alias translation key to
+its translation file.
+
+#### Complete list of search alias translation keys
+| Element                     | Translation Key                           |
+|-----------------------------|-------------------------------------------|
+| `Dev` menu                  | `"dev.menu.aliases"`                      |
+| `Collab` menu               | `"menu.collab.aliases"`                   |
+| `Decompiler` menu           | `"menu.decompiler.aliases"`               |
+| `Help` menu                 | `"menu.help.aliases"`                     |
+| `Search` menu               | `"menu.search.aliases"`                   |
+| `Crash History` menu        | `"menu.file.crash_history.aliases"`       |
+| `File` menu                 | `"menu.file.aliases"`                     |
+| `Open Recent Project` menu  | `"menu.file.open_recent_project.aliases"` |
+| `Save Mappings As...` menu  | `"menu.file.mappings.save_as.aliases"`    |
+| `View` menu                 | `"menu.view.aliases"`                     |
+| `Entry Tooltips` menu       | `"menu.view.entry_tooltips.aliases"`      |
+| `Languages` menu            | `"menu.view.languages.aliases"`           |
+| `Server Notifications` menu | `"menu.view.notifications.aliases"`       |
+| `Scale` menu                | `"menu.view.scale.aliases"`               |
+| `Stat Icons` menu           | `"menu.view.stat_icons.aliases"`          |
+| `Themes` menu               | `"menu.view.themes.aliases"`              |

README.md

@@ -2,6 +2,10 @@
 
 A tool for deobfuscation of Java bytecode. Forked from <https://bitbucket.org/cuchaz/enigma>, originally created by [Jeff Martin](https://www.cuchazinteractive.com/).
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
 ## License
 
 Enigma is distributed under the [LGPL-3.0](LICENSE).

enigma-swing/src/main/java/org/quiltmc/enigma/gui/element/SearchableElement.java

@@ -7,18 +7,32 @@
 import java.util.stream.Stream;
 
 public interface SearchableElement extends MenuElement {
+
+	String ALIASES_SUFFIX = ".aliases";
+	String ALIAS_DELIMITER = ";";
+
 	default Stream<String> streamSearchAliases() {
 		final String aliases = I18n
-				.translateOrNull(this.getAliasesTranslationKeyPrefix() + ".aliases");
+				.translateOrNull(this.getAliasesTranslationKeyPrefix() + ALIASES_SUFFIX);
 
 		return Stream.concat(
 			Stream.of(this.getSearchName()),
-			aliases == null ? Stream.empty() : Arrays.stream(aliases.split(";"))
+			aliases == null ? Stream.empty() : Arrays.stream(aliases.split(ALIAS_DELIMITER))
 		);
 	}
 
 	String getSearchName();
 
+	/**
+	 * Returns a translation key prefix used to retrieve translatable search aliases.<br>
+	 * Usually the prefix is the translation key of the translatable element.
+	 *
+	 * <p> {@value ALIASES_SUFFIX} is appended to create the complete translation key.<br>
+	 * Alias translations hold multiple aliases separated by {@value ALIAS_DELIMITER}.
+	 *
+	 * <p> <em>All</em> alias translation key prefixes should be documented in {@code CONTRIBUTING.md} under<br>
+	 * {@code Translating > Search Aliases > Complete list of search alias translation keys}
+	 */
 	String getAliasesTranslationKeyPrefix();
 
 	void onSearchClicked();