---
title: Shipping
description: General information about the shipping process
---

## What does shipping mean?
Shipping means making your project public for people to see and use. Once this gets approved, you will get pages which you can
use to buy prizes from the shop, or fund hardware builds. Something that you ship must be publically accessable and play/usable it must be as a public git repo (GitHub, GitLab, etc.) or a public website. If you are making a hardware project, you will need to have a video of your project working and a public git repo with the code and files for your project.

## What do I need?

### Readme.md
You need to have a readme.md file with information about your project, how to run it and what it is.
It should have:
- A short description of your project (one line is enough)
- Why you made it
- How to run it (if applicable)
- Photos/Demo
### File organisation
You can't just have a bunch of files in a folder, they need to be organised in a way that makes sense and is easy to understand.
### Usability
Your project has to actually work and be able to run on the device it is intended for. If it is a website, it should be able to run on a browser, if it is a hardware project, it should be able to run on the hardware it is intended for. If something is incomplete, say so in the readme, so the reviewers don't have to find it themselves.
### AI Disclosure
You are allowed to use AI tools as a TOOL to help you with your project, but you must disclose it in your readme. You should NOT write the whole thing with AI, we can tell and it can get you banned.
If you are having trouble with your project, you can ask in the slack channel for help or even just google it, google is your best friend.
### License
It must have a license file in the root of your project. You can use [choosealicense.com](https://choosealicense.com/) to find a license that works for you. If you don't know what license to use, you can use the MIT license, which is a permissive license that allows others to use your code as long as they give you credit.


## Reviews
Reviewing is how you get your prizes! Once you ship your project, it will be added to the queue where one of our
reviewers will look at your project and give you feedback. Once they approve it, you will get your books based off
the hours you spent on your project. If they request changes, you will get feedback on what to fix and you can resubmit it for review.

### What is checked?
When your project is reviewed, the reviewer will check for a few things, such as:
- Does it work?
- Is it related to study?
- Is it made by you, not AI?
- Is the readme.md file complete and informative and NOT made by AI?
- Is it publically accessible?
- Is it organized and easy to understand?
### What can happen?
When your project is reviewed, there are a few things that can happen:
- It can be approved and you will get your books!
- It can be requested changes, and you will have to make the changes and resubmit it for review.
- It can be rejected, and you will not get your books. This is usually because the project is not related to study, or it is not made by you, or it is not publically accessible, or it is not organized and easy to understand. This can also be because fraud was suspected but you should also get a DM from Fraud Squad if that is the case. If you feel that your project was rejected unfairly, you can appeal the decision by sending a message in the help channel on slack and one of the admins will look into it.
### How does it work?
When you submit your project, it will be added to the queue where one of our reviewers will look at your project and give feedback on your project. As well as this, it will also
be fraud reviewed by the Fraud Squad to make sure that you are not doing anything sketchy with your hours, so please be patient
with reviews as this is not managed by us.

This is a volunteer run program, so please be patient with reviews as this is not managed by us. We will try to get to your project as soon as possible, but please be patient and do not spam the reviewers or the help channel on slack. If you have any questions about your review, you can ask in the help channel on slack and one of the admins will look into it.
