Contributing

Intro

You might want to contribute code, content or time to this wiki and are unsure how to do so. Please follow the steps below on how to do so.

Note

All of these sections mentioning Github require a Github account!

Making Suggestions for Edits

If you’re not comfortable writing Markdown or using Git you can make suggestions for edits via our project’s Github issues or simply open a ticket in our Discord detailing the changes needed. Please note that if you are able to make changes via Markdown and Git that is the preferred method. If you wish to contribute directly please click here.

Making Suggestions via Github

Github is a great place to make suggestions to our site and might be the better option if you fall into the following two groups.

  1. Power users who simply don’t feel comfortable making edits
  2. You are not in our Discord or simply don’t use Discord.

To get started with Github issues you will first need a Github account. You can sign up and join via a few methods so please refer to Github’s signup page.

Assuming you have an account and are signed in head to the Issues section of our project and follow these steps.

  1. First make sure that your issue doesn’t already exist and then click the New Issue button.
  2. Make the following changes. You can see an already filled out example below.
  • Type in the title box a brief summary / title about what you want changed.
  • Type in the description tab details outlining a more detailed change. Include as much detail as needed to clearly convey this issue. GitHub Issue
  1. Click Submit New Issue.
  2. Wait at least a day to see if your issue has been updating asking further details or had any changes made.

Making Suggestions via Discord

This section assumes the following:

  • You’re currently in ShadowNode’s Discord
  • You’re able to make a ticket

If you’re a member of our community it’s likely easiest for you to submit a ticket via our Discord and have it flagged to the Wiki Authors. To do this is fast, simple and easy. All it requires is you to have a Discord account and be in ShadowNode’s Discord.

Let’s get started:

  1. Click the #tickets channel.
  2. Click Create Ticket. Create a Ticket
  3. For the server select “Not Applicable” Create a Ticket Step 2
  4. Fill the ticket out as normal, clicking the checkmark below your response confirmation after each step. If you need to edit your reply you can click the red “X” instead and it’ll allow to do so. When complete it should look like this. Create a Ticket Step 3
  5. After your ticket is created simply type into the ticket’s channel the suggestion and optionally include screenshots of outdated areas.
Note

You might be asked for further details and clarification so be sure to pay attention to the ticket!

Contributing Code / Content Directly

If you’re familiar with Markdown and Git you might wish to contribute code and content to this wiki directly. Please note that all content submitted is handled via Pull Requests and is reviewed by our staff prior to being approved.

First Step

There’s two ways to do this:

If you just want to simply edit one of the existing pages you just click the Edit this page in the top right of the page! Then skip to Step 3

Or if you want to create a new section go to the project and click the Fork button.

Second Step

This step is only if you did the second option in the First Step

Once you have clicked the fork button you will be redirected to your version of the github repo. On there you must go into the content folder, this is where all of the posts on here are located.

Now you can create a new section by simply making a new folder, on github this is done in the edit screen which you can get to by clicking Create new file. You then simply type what you want the folder to be named followed by a /.

If you want your new section follow the steps in Step 3 but inside a file called _index.md inside the folder!

Third Step

This is where you now design your post.

If you created a new file you must put:

---
title: Contributing
author: Bennyboy1695
---

at the top of the file, and the file must have .md at the end!

Then you just simply write everything in a language called Markdown. A guide of how things will look on our site can be seen here of course we have a slightly different color scheme but the layout is the same!

Fourth Step

Now you have edited/created your files you must use github to create a pull request to get them on the actual website.

To do this a handy guide can be found here