loot/loot.github.io
0
0
Fork 0
mirror of https://github.com/loot/loot.github.io.git synced 2026-07-27 14:13:30 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update General Hints section of Masterlist Editing article

Browse Source 
* Add links to forum thread & Discord server for discussing changes.
  * Edit bullet point on comments to reflect our current preferences.
  * Edit bullet point on separating newlines to reflect our current
    preferences.
  * Edit bullet point on plugin placement to inform contributors of how
    we group plugins.
  * Fix various grammatical issues.
This commit is contained in:
sibir-ine
2021-11-19 19:40:54 -08:00
parent 745fae1b8b
commit 3af692bf95
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing/Masterlist-Editing.html
+6 -6
View File
@@ -8,12 +8,12 @@ title: Masterlist Editing
<h3>General Hints</h3>
<ul>
<li>Look in the masterlists for examples, and see the <a href="https://loot-api.readthedocs.io/en/stable/metadata/introduction.html">Metadata Syntax documentation</a> for the details.</li>
<li>Only make edits/additions you're confident about - otherwise create an issue in the masterlist repository's issue tracker, or discuss in the official LOOT forum thread.</li>
<li>Make as many silent comments as you want within the masterlists - it doesn't hurt (within reason). However, make sure to put them <em>above</em> the line(s) that they refer to.</li>
<li>Use blank lines to separate mods that are grouped together or where it helps readability.</li>
<li>Where you put a plugin doesn't matter - you may want to see if there are any related plugins in the masterlist already and group them together, or you can just add the plugin to the end of the list.</li>
<li>Test your changes before uploading them, to make sure you didn't make any syntax mistakes. See <a href="Quickly-Testing-Your-Masterlist-Changes.html">Quickly Testing Your Masterlist Changes</a> for instructions.</li>
<li>Look in the masterlists for examples and see the <a href="https://loot-api.readthedocs.io/en/stable/metadata/introduction.html">Metadata Syntax documentation</a> for the details.</li>
<li>Only make edits/additions you're confident about - otherwise, create an issue in the masterlist repository's issue tracker or discuss in the official LOOT <a href="https://loot.github.io/latest-thread/">forum thread</a> or <a href="https://loot.github.io/discord/">Discord server</a>.</li>
<li>You can leave silent comments within the masterlists if you want to stress the rationale for a choice in metadata you've made, but it's preferable to put those details in the commit message. They can then be viewed in the blame. If you do leave comments, make sure to put them <em>above</em> the line(s) that they refer to.</li>
<li>Use blank lines to separate plugin that are hosted on different mod web pages or where it helps readability. Plugins from the same mod web page shouldn't be separated.</li>
<li>The masterlists are separated into sections of plugins that modify similar aspects of the game. You can put a plugin in an appropriate section or at the end of the masterlist if you're unsure which section is appropriate. New sections can be added if the current sections available don't accurately reflect the plugin you're moving/adding.</li>
<li>Test your changes before uploading them to make sure you didn't make any syntax mistakes. See <a href="Quickly-Testing-Your-Masterlist-Changes.html">Quickly Testing Your Masterlist Changes</a> for instructions.</li>
</ul>
<h4>Notepad++</h4>