Submission Rules

This step only needs to be performed one time.
The submission process is now handled through GitHub. This provides a bunch of useful tools for the verifiers and helps with individual responses to submissions.

1. First you will need to create a GitHub account: Create a GitHub Account
2. Then create a fork of the Candy's Shop Repository: Fork Repository (If you already have and your fork is out of date, click "Sync Fork" on your forked repository page https://github.com/<username>/candys-shop)

Making a branch

Next, you will be making a branch for your song

1. Navigate to your fork at https://github.com/<username>/candys-shop.
2. Ensure the branch on the top-left of the screen is main. If it is not, click the button, and it will produce a dropdown of branches. Select main from that list.

3. Ensure your main branch is synced. To do so, click the Sync Fork button. This will produce a popup. If there's an option which says Update branch, click it.

4. Click the button named main that was referenced in step 2. It will produce a popup with a search field, type in the name of your song. It will produce a button which will say Create branch {name} from main. Click it.

Upload your files

Once you have made or synced your fork, you will now need to upload your files to GitHub. These include:

• Binary File*: The binary file containing your song converted by the online midi converter, with your loop.
• Preview File: A .mp3 file which contains a playback of your song played in-game. It's strongly advised to ensure that your preview file contains nothing other than your song, and that you use a tool such as Audacity to remove anything that's not your song.
  Your preview should also contain your song looping once. This isn't necessary to have if you prefer to attach a YouTube Video instead.
• MIDI File*: The MIDI used to make your song, which will be used for us to provide feedback, and to ascertain critical information about your submission.

To add these files, perform the following steps:

1. Visit your fork at: https://github.com/<username>/candys-shop
2. Click Add File and then Upload Files
   

3. Upload your files in question. They don't have to be sorted into the necessary folders in the binaries and previews folders. GitHub will automatically do this once your submission is approved.

4. Click "Commit directly to the {name} branch.", and then click "Commit changes".

Make your pull request

You will need to make a pull request with the following information copied in:

To create the pull request:

1. Visit your fork at: https://github.com/<username>/candys-shop
2. Click Pull Requests, then New Pull Request

3. It will then produce a series of dropdowns. On the right-hand-most dropdown, select your branch that you created.

4. Click Create Pull Request
5. Copy in the above snippet of data to the text of your pull request. Then click Create pull request.

6. Upon creating your pull request, you will get a comment from the bot which will tell you various bits of information about your request. This information is mostly important to verifiers, but check what it has said just in case you've made an error with your submission and need to edit your PR comment. The music verification team will proceed to examine your submission and may respond to you with feedback and changes that are deemed necessary in order for the song to be approved. It is heavily advised you keep an eye on your submissions to see whether there's any feedback you need to respond to.

Fill in submission details