Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Contributing

seamussmith edited this page Feb 1, 2022 · 16 revisions

Contributing

Prerequisite: Creating a Dev Environment

Things to know:

  • All of the things we need to do are put in as issues in our GitHub. We usually sort those issues into a project or a milestone. For example: The MVP milestone and the MVP project.

Step 1: Make a fork

Top right corner of the GitHub page, click the fork button. This will create a fork on your personal GitHub account.

Step 2: Clone your fork to your PC

pretty sure you know how to do this (todo: figure out what to put here)

Step 3: Make your changes

You don't need to branch off master. We do master only 'round these parts.

Step 4: Make a pull request

Protip: If you put something like Resolves #45 or whatever the issue ID is in your PR's message, upon merging the pull request, the issue will be automatically closed.

Step 5: Document features if you can

If you don't know how you should document your features, you could look at other documentation or look at Documentation Guidelines