2025-Regionals-Shared

Deadline to submit: March 14th at 6pm CT

The Repository for SWCCDC teams to submit team-made docs and code they wish to bring into the game environment. You must submit a pull request against this repo by the deadline above for consideration. The Southwest CCDC team will review and merge acceptable submissions.

Rules for submission:

• Your PR/submission should contain all the materials in you school's folder
• All files must be plaintext and NOT ENCRYPTED OR OBFUSCATED in any way
• You may only submit things your team has created or modified for use during the game that you have the rights to distribute
• Everything posted to this repo must be available for any team to use and open to scrutiny by the competition organizers AND other teams.
• You may submit a maximum of 15,000 lines at 400 characters per line
• No binary files except for PDF, DOC, PNG, and PPT
• No compressed files (zip, tar, etc.)

If you have any questions or need help, reach out to Gold Team or Black Team on Discord.

How to Upload

You can create a pull request through the GitHub UI without interacting with git on the command line.

1. Fork the Repo

While logged in to GitHub (you do need to have an account), click the "Fork" button on https://github.com/SouthwestCCDC/2024-Regionals-Shared/.

This will take you to a fork in your account.

Then navigate to the folder for your school.

2. Upload Files and Commit Them

Click the "Add File" button and the "Upload Files" button that appears in the drop-down menu.

Drag and drop the files that you wish to upload.

Once you have uploaded the files, scroll down and commit the changes. Please use a descriptive commit message.

3. Create the Pull Request

You should now see that your fork is "ahead" of the main repository.

Click the "Contribute" button and then "Open Pull Request" button in the drop down.

You will be taken to a screen to compare and confirm the changes. If everything looks good, click the "Create Pull Request" button.

Give the PR a name and an (optional) description if you feel that it will help us review the submission. Once you are done, click "Create Pull Request" at the bottom.

4. Verify CI jobs pass

We utilize Github workflow CI jobs to scan the files added to make sure they comply with out requirements.

We will not start reviewing a PR until all CI jobs are passing, so after you create the pull request verify the jobs all pass.

5. Done!

Congratulations! You have opened a Pull Request. We will review it and merge if everything looks good.