imported>PvME corpus import: Attributed pinned PvME snapshot 074a9438f79d10fba75735791be0030734db8b5e; CC BY-NC-SA 4.0

2026-11-11T14:25:57Z

Attributed pinned PvME snapshot 074a9438f79d10fba75735791be0030734db8b5e; CC BY-NC-SA 4.0

New page

[[PvME|PvME guide index]]

<h2 id="introduction"><ins><nowiki>Introduction</nowiki></ins></h2>
<nowiki>
</nowiki><p><nowiki>All of our guides are hosted on GitHub, this is an online service which allows for anyone to make changes to our guides.</nowiki></p>
<nowiki>
</nowiki><p><nowiki></nowiki></p>
<nowiki>
</nowiki><p><strong><nowiki>Before starting there are two important things to know:</nowiki></strong></p>
<nowiki>
</nowiki><p><nowiki>⬥ Don't be scared, you wont break anything!</nowiki></p>
<nowiki>
</nowiki><p><nowiki>⬥ If you are unsure about </nowiki><strong><nowiki>anything</nowiki></strong><nowiki> feel free to ping a member of the editing staff in </nowiki>[https://discord.com/channels/534508796639182860/724129126314803230 <nowiki>Editors chat (external Discord)</nowiki>]</p>
<nowiki>
</nowiki><p><nowiki></nowiki></p>
<nowiki>
</nowiki><p><em><strong><nowiki>Note:</nowiki></strong><nowiki> Make sure that your GitHub account DOES NOT dox you. It is recommended to use a separate account to work etc, as username and email are visible.</nowiki></em></p>
<nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>

</nowiki><div><nowiki>
</nowiki><div></div>
<nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>
</nowiki><div><nowiki>

</nowiki><div id="block-yourfirstedit"><u><nowiki>Your First Edit</nowiki></u><nowiki>
</nowiki></div>
<nowiki>
</nowiki><div style="white-space: pre-line"><nowiki>Ask questions if you get stumped
</nowiki><strong><em><nowiki>Bolded and Indented</nowiki></em></strong><nowiki> text will change for future edits, but the procedure is the same!
For a visual guide, check </nowiki>[https://youtu.be/6sTpzSYtVQI <nowiki>this video</nowiki>]<nowiki>, feel free to follow along to make your first edit.
</nowiki></div>
<nowiki>
</nowiki><div><div><div><u><nowiki>Setting up to Edit</nowiki></u><nowiki>
</nowiki></div>
<div style="white-space: pre-line"><nowiki>⬥ Get your own copy of repository on github (fork the repository)
    • Go </nowiki>[https://github.com/pvme/pvme-guides <nowiki>here</nowiki>]<nowiki>, make an account, then click fork at the top right.
⬥ Find the </nowiki><strong><em><nowiki>github-tutorial</nowiki></em></strong><nowiki> file (use the search bar at the top) and copy it
    • You can also manually navigate the folders </nowiki><strong><em><nowiki>(editor-resources/github-tutorials)</nowiki></em></strong><nowiki> to find it.
    • This may be needed just after you fork the repository.
⬥ Paste the guide into the </nowiki>[https://pvme.github.io/guide-editor/ <nowiki>Guide Editor</nowiki>]<nowiki>
</nowiki></div>
</div>
<div><div><u><nowiki>Making the Changes</nowiki></u><nowiki>
</nowiki></div>
<div style="white-space: pre-line"><nowiki>⬥ </nowiki><strong><em><nowiki>Add your name to the bottom of the 'completed github tutorial' list</nowiki></em></strong><nowiki>
    • To add your name, type <@id> replacing id with your discord id
    • To get your id you need to enter developer mode (settings, advanced, turn on developer mode)
    • Click my account, and then using the three dots next to your name, copy user id
⬥ Save the edited guide to a .txt document on your computer
⬥ Head to bot test, type </nowiki><code><nowiki>pvme$txtpost</nowiki></code><nowiki>, and attach your document
⬥ Check everything works
</nowiki></div>
</div>
<div><div><u><nowiki>Submitting them to GitHub</nowiki></u><nowiki>
</nowiki></div>
<div style="white-space: pre-line"><nowiki>⬥ Edit the guide in your Repository with your change
    • The edit button is on the top right
⬥ Commit these changes
    • The commit button is on the top right
⬥ Head to the homepage of your repository
    • Click </nowiki><code><nowiki><>code</nowiki></code><nowiki> on the top left
⬥ Click contribute
⬥ Click open pull request
⬥ Make sure the title explains the changes you are making
⬥ Click create pull request
⬥ Done!
</nowiki></div>
</div>
</div>
<nowiki>
</nowiki></div>
<nowiki>

</nowiki></div>
<nowiki>

</nowiki></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<nowiki>

</nowiki><p><nowiki>From here one of our editing staff will review the pull request, check that everything works, and then merge it into PvME!</nowiki></p>
<nowiki>
</nowiki><p><nowiki></nowiki></p>
<nowiki>
</nowiki><p><strong><em><nowiki>Note:</nowiki></em><nowiki>* The first step in "</nowiki></strong><ins><nowiki>Setting up to Edit</nowiki></ins><nowiki>*</nowiki><em><nowiki>" only need to be done the first time!</nowiki></em></p>
<nowiki>
</nowiki><h2 id="whats-next"><ins><nowiki>Whats Next?</nowiki></ins></h2>
<nowiki>
</nowiki><p><nowiki>Head into </nowiki>[https://discord.com/channels/534508796639182860/1152990486714388622 <nowiki>Editing jobs (external Discord)</nowiki>]<nowiki> and have a look at the jobs! We recommend you find an easy one and just give it a go! Make sure to message or ping </nowiki><span><nowiki>Editing Staff (community role)</nowiki></span><nowiki> in </nowiki>[https://discord.com/channels/534508796639182860/724129126314803230 <nowiki>Editors chat (external Discord)</nowiki>]<nowiki> if you need help.</nowiki></p>
<nowiki>
</nowiki><p><nowiki></nowiki></p>
<nowiki>
</nowiki><p><nowiki>Have a look at the tools and references that are available in </nowiki><span><nowiki>Referenced guide unavailable in this snapshot</nowiki></span><nowiki>. Don't feel the need to read through all of them, just have a look what you think will be useful to you.</nowiki></p>
<nowiki>

</nowiki>
== Attribution and source history ==
Adapted from [https://pvme.io/pvme-guides/editor-resources/github-tutorials/github-quick-guide/ <nowiki>Github Quick Guide</nowiki>] by PvME contributors. [https://github.com/pvme/pvme-guides/commits/master/editor-resources/github-tutorials/github-quick-guide.txt Upstream source history]. Licensed [https://creativecommons.org/licenses/by-nc-sa/4.0/ CC BY-NC-SA 4.0]. Snapshot 074a9438f79d10fba75735791be0030734db8b5e. Formatting adapted for standalone MediaWiki; media and third-party references remain external links.

PvME/Contributing/Github Quick Guide - Revision history

imported>PvME corpus import: Attributed pinned PvME snapshot 074a9438f79d10fba75735791be0030734db8b5e; CC BY-NC-SA 4.0