Contributing

Table of Contents

1. Making Edits
2. Style Guidelines
3. Adding New Pages

Making Edits

This website is powered by Jekyll using the Just the Docs theme. Check out their website for formatting information.

At the bottom of every page is a link that says “Edit this page on Github” which will take you directly to the page on Github for editing. You can also just open the file you want to edit in Github.

Here are the steps to make an edit:

1. Make a fork of the project
2. Make a branch to make your changes
3. Commit your changes
4. Submit a pull request to have your changes added to the website
5. Make any additional edits if requested by the reviewer
6. All done

The process is also described in this Microsoft tutorial.

Style Guidelines

Use the AP style when possible unless stated otherwise below:

• Use the Oxford comma
• Always use figures even if below 10 for clarity
• Don’t put periods at the end of a list item

Additionally:

• It is ok to use opinionated language as long as it’s accurate and good advice for most
• Use lists and tables often for organizing information

Adding New Pages

Pages are categorized as the following:

Every page must start with YAML information so the website adds it to the navigation. Here is an example:

---
layout: default
title: Coding HS
parent: High School Competitions
---

Then add the title with and h1 header #.

To add an auto-generating table of contents, use the code below:

## Table of Contents
{: .no_toc .text-delta }

1. TOC
{:toc}

Subsequent headers should use h2 ## and children of those headers should use h3 ### and so on.

Every h2 header should be separated with a horizontal line divider ---.

Most competition guides will have the sections below though they are removed if there is currently no information under them. Subsections may also be added.

1. Overview
2. Rules
3. Competing
4. Additional Tips
5. Examples
6. Additional Resources