Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

44 lines (36 loc) · 3.12 KB
Raw

How to contribute

General rules

  • Don't delete any resources unless duplicates.
  • When uploading tests, try to keep the naming convention similar to currently existing tests.
  • Don't upload anything with SCSA material in it.

Uploading files

There's a couple ways to contribute by adding your own tests or notes to the repository, described below.

With the GitHub website

Unfortunately the GitHub website only allows for uploading of folders/files, or editing files individually. This means that you'll be able to only upload tests/notes using the website, so depending on how you're contributing you may need to use the other method.

To upload a file:

  1. First you'll need to fork the repository (make your own copy of it), by going here and clicking Fork near the top right.
    • If you've done this in past there's no need to create a second fork.
  2. Go to the folder in your fork's repository where you want the file(s) uploaded.
  3. Drag-and-drop the file from your file explorer onto the website.
  4. If you want to add multiple files to the same location, just continue dragging them.
  5. Describe the changes you made, then press Commit changes.
  6. To merge your files this repository from your fork, go to your fork's main page (wace/) and click the pull request button then follow the steps.

To upload a folder:

  • Do the exact same process as above.

By cloning the repository

Note that the repository is very large (over 16 GB) so it may be preferential to use the other option. Steps:

  1. You may first have to download and install Git if your computer doesn't have it already.
  2. Then you'll need to fork the repository (make your own copy of it), by going here and clicking Fork near the top right.
    • If you've done this in past there's no need to create a second fork.
  3. Open your terminal in the directory that you want to download the repository to.
  4. On your fork's repository, find the Code dropdown button and copy the .git link shown. Then type git clone link in the terminal, using the link. For example, it might be git clone https://github.com/wacedungeoner/wace.git
    • If you have already done this in past, before you make any further changes you should type git fetch to update the local copy on your computer.
  5. Make your changes, by uploading/removing/renaming files.
    • You can review the changes you've made by typing git status
  6. To make Git recognise all your changes, type git add -A
  7. Then to upload your changes to your fork, type git commit -m message, replacing message with a description of your changes, and then type git push
  8. After uploading your changes, to merge them into this repository from your fork, go to your fork's main page (wace/) and click the pull request button then follow the steps.

Sorting and renaming

You might have noticed that there are some sections in the repository which are still unsorted, or may have mistakes with the test names.

There doesn't seem to be any way to rename folders or relocate files on the GitHub website, so you'll have to follow the cloning guide above.