Update wiki-style links between docs

This commit is contained in:
Oliver Hamlet
2016-04-09 13:50:34 +01:00
parent e1e6ef519a
commit 2e4aa21e8f
3 changed files with 9 additions and 9 deletions
+5 -5
View File
@@ -19,17 +19,17 @@ title: How To Contribute
<h3 id="making-changes">Making Changes</h3>
<p>Open the repository that contains the file(s) you want to edit in GitHub Desktop, then click the gear icon in the upper right corner of the window and select &quot;Open in explorer&quot; to view the repository contents.</p>
<p>Edit the file(s) you want to make changes to using your text editor or appropriate tool of choice, then once you're done, save the file and switch back to GitHub Desktop. There you can make a commit, sync and create a pull request as described in the forking guide linked to above.</p>
<p>If you're editing a masterlist, see the [[Masterlist Editing|Masterlist-Editing]] page for more information.</p>
<p>If you're editing a masterlist, see the <a href="Masterlist-Editing.html">Masterlist Editing</a> page for more information.</p>
<h3 id="joining-the-team">Joining the Team</h3>
<p>Contributors can ask or be asked to join the LOOT team, which grants write access to the LOOT repositories, their issue trackers and wikis. Addition of new team members is done by the team admins, who base their decision on the quality of past contributions. If you would like to join the team, and feel comfortable with the workflow, contact a [[team member|Team-Members]].</p>
<p>Contributors can ask or be asked to join the LOOT team, which grants write access to the LOOT repositories, their issue trackers and wikis. Addition of new team members is done by the team admins, who base their decision on the quality of past contributions. If you would like to join the team, and feel comfortable with the workflow, contact a <a href="/docs/team/Team-Members.html">team member</a>.</p>
<h3 id="contributing-as-a-team-member">Contributing as a Team Member</h3>
<p>Team members don't need to fork LOOT repositories, and can instead clone the original repositories and edit their files directly. This introduces a few additional points to ensure team members work well together:</p>
<ol style="list-style-type: decimal">
<li>Make sure that your local repository is in sync with the online repository before and after you make any changes. This helps to avoid conflicts.</li>
<li>It's always best to make commits in your own branch, and merge them into the repository's <code>master</code> branch when you're done working. For one-off commits the advantage is not so clear, but if you are making a set of commits with a common theme, a branch will help keep things organised.</li>
<li>If you have committed changes to your local repository, and someone else synced their changes to the online repository after you last synced, then you may need to manually merge the changes. You'll know if you have to do this because GFW will give you an error message when you try to sync, in which case see [[Resolving Conflicts|Resolving-Conflicts]].</li>
<li>You should also have a read of the [[Team Policies|Team-Policies]] and [[Team Member Responsibilities|Team-Member-Responsibilities]] pages to familiarise yourself with their contents.</li>
<li>If you have committed changes to your local repository, and someone else synced their changes to the online repository after you last synced, then you may need to manually merge the changes. You'll know if you have to do this because GFW will give you an error message when you try to sync, in which case see <a href="Resolving-Conflicts.html">Resolving Conflicts</a>.</li>
<li>You should also have a read of the <a href="/docs/team/Team-Policies.html">Team Policies</a> and <a href="/docs/team/Team-Member-Responsibilities.html">Team Member Responsibilities</a> pages to familiarise yourself with their contents.</li>
</ol>
<h3 id="getting-help">Getting Help</h3>
<p>If you have any problems or questions regarding anything relating to LOOT, feel free to ask team members questions: the [[Team Members|Team-Members]] page lists members' usernames on the Bethesda Softworks Forums, Nexus Forums and GitHub.</p>
<p>If you have any problems or questions regarding anything relating to LOOT, feel free to ask team members questions: the <a href="/docs/team/Team-Members.html">Team Members</a> page lists members' usernames on the Bethesda Softworks Forums, Nexus Forums and GitHub.</p>
<p>Questions are best asked of those who contribute to the relevant repository. For example, if you have a question that's specific to a game's masterlist, it's best to ask that masterlist's contributors. Repository contributors can be viewed by clicking on the contributor count in the bar near the top of the repository's page.</p>
+1 -1
View File
@@ -12,7 +12,7 @@ title: Masterlist Editing
<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 [[Quickly Testing Your Masterlist Changes|Quickly-Testing-Your-Masterlist-Changes]] for instructions.</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>
<h3 id="writing-style">Writing Style</h3>
<p>For consistency and to make it easier for people to understand what others have written, it's best to use the following style points when editing the masterlist.</p>
+3 -3
View File
@@ -10,14 +10,14 @@ title: Team Member Responsibilities
<ul>
<li>Consider and make any changes suggested on the forum thread or by PM (discuss the changes first if you think it is warranted).</li>
<li>Merge any pull requests which make changes you think are appropriate. If a pull request makes any inappropriate changes, discuss them with the author in the pull request's message thread.</li>
<li>Create a new forum thread whenever the current one reaches its 200 post limit. See [[Thread Management|Thread-Management]] for instructions.</li>
<li>Create a new forum thread whenever the current one reaches its 200 post limit. See <a href="Thread-Management.html">Thread Management</a> for instructions.</li>
</ul>
<h3 id="admins">Admins</h3>
<p>When discussions on policy or particular changes reach a stalemate, you get to make a decision on the result. That doesn't mean people will listen, of course... :P It's always good to try to reach consensus, and other admins can also make a different decision, so you might still have to argue it over with them.</p>
<p>You're also a more visible contact point for people with queries about LOOT, people may send you PMs with changes too. Just answer queries as best you can, or forward them on to those who you think could answer them better, and either make changes/additions yourself or post them into the relevant thread for the regular maintainers to process.</p>
<p>Finally, you're responsible for adding new members. GitHub's excellent Forking feature allows people to contribute to repositories that they don't have write access to, and you should take full advantage of that:</p>
<ul>
<li>If someone who hasn't contributed on GitHub asks for addition to the team, politely refer them to the [[How To Contribute|How-To-Contribute]] wiki page, saying that they can contribute without being a team member.</li>
<li>If someone who hasn't contributed on GitHub asks for addition to the team, politely refer them to the <a href="/docs/contributing/How-To-Contribute.html">How To Contribute</a> wiki page, saying that they can contribute without being a team member.</li>
<li>If someone who has contributed on GitHub asks for addition to the team, take a look at their contributions (on their user page, in the &quot;Repositories contributed to&quot; list) and see if their contributions have been accepted or not to decide whether or not to grant them access. If their most recent pull requests have been rejected, it may be better to reply with a polite &quot;not until we're happy with your contributions&quot; message.</li>
</ul>
<p>To add a GitHub user to the team, go to the <a href="https://github.com/orgs/loot/teams/looters">Looters team page</a> and click the &quot;Add member&quot; button, then enter their username in the search box displayed and select the correct match. Then, go to the [[Team Members|Team-Members]] wiki page and add their names to the list.</p>
<p>To add a GitHub user to the team, go to the <a href="https://github.com/orgs/loot/teams/looters">Looters team page</a> and click the &quot;Add member&quot; button, then enter their username in the search box displayed and select the correct match. Then, go to the <a href="Team-Members.html">Team Members</a> wiki page and add their names to the list.</p>