From c1d0d9db1f580a757ee43390038784d5228d4c44 Mon Sep 17 00:00:00 2001 From: Juuxel <6596629+Juuxel@users.noreply.github.com> Date: Thu, 26 Mar 2020 16:12:00 +0200 Subject: [PATCH] Add CONTRIBUTING.md, mention mojmap being ARR (#1222) * Add CONTRIBUTING.md, mention mojmap being ARR Closes #1221. Created CONTRIBUTING.md file that is basically a copy-paste from the README. Closes #1209. CONVENTIONS.md now mentions that names from mojmap should not be used. * Suggestions --- CONTRIBUTING.md | 8 ++++++++ CONVENTIONS.md | 2 ++ README.md | 7 ++++--- 3 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..04f6c1f8f7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing + +Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP or Mojang's obfuscation maps) +is **completely forbidden** without explicit permission from the owners of said mappings to distribute the names under the CC0 license. +This includes using the names from those mappings for inspiration. Discussing the naming approaches used in said projects +is also not welcome - you have been warned. However, it is a good idea to consult name changes with other people - use pull requests or our community spaces to ask questions! + +Please have a look at the [naming conventions](/CONVENTIONS.md) before submitting mappings. diff --git a/CONVENTIONS.md b/CONVENTIONS.md index a7db58a81c..d14ad2a3f4 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -115,6 +115,8 @@ Name screen coordinates `x` and `y`, rather than `left` and `top`. ## Mojang names +**Do not use names from Mojang's obfuscation maps.** + Use names that match names in strings in the vanilla code, unless that string is outdated or inaccurate. This avoids confusion, especially from new modders who may not understand what an class exception message is referring to. diff --git a/README.md b/README.md index 91663a7ff2..e4a471c51d 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ To obtain a deobfuscated Minecraft jar, [`./gradlew mapNamedJar`](#mapNamedJar) ## Contributing -Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP) is **completely forbidden** without explicit permission from the -owners of said mappings. Discussing the naming approaches used in said projects is also not welcome - you have been warned. -However, it is a good idea to consult name changes with other people - use pull requests or our community spaces to ask questions! +Please remember that copying and pasting mappings from alternate projects under more restrictive licenses (such as MCP or Mojang's obfuscation maps) +is **completely forbidden** without explicit permission from the owners of said mappings to distribute the names under the CC0 license. +This includes using the names from those mappings for inspiration. Discussing the naming approaches used in said projects +is also not welcome - you have been warned. However, it is a good idea to consult name changes with other people - use pull requests or our community spaces to ask questions! Please have a look at the [naming conventions](/CONVENTIONS.md) before submitting mappings.