mirror of https://github.com/FabricMC/yarn.git
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
This commit is contained in:
parent
ab49bb2e7b
commit
c1d0d9db1f
|
@ -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.
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
Loading…
Reference in New Issue