Contributing

Authors: Nathan Wang, Benjamin Qi

How to contribute!

Note that the USACO Guide has a public Github Repository. Feel free to contribute by submitting issues and Pull Requests!

Please help fix some of the issues on our Github Repository!

Ways to Contribute

Some examples:

Lesson

  • Convert lists of resources to tables (Plat / Advanced).
  • Add missing descriptions for sections, modules, or resources.
    • All resources should have descriptions.
  • Improve explanations for sample problems.
    • If starred resource or editorial already has a good explanation, no need to repeat it.
  • Improve implementations.
    • Include code handling input & output.
    • Should be consistent across languages.
  • Adding modules!

Problems

  • Convert lists of problems to tables (Plat / Advanced).
  • Fix problem difficulties and tags.
  • Add problems that are good examples of the module topic (and remove those that are not).
  • Adding official editorial links.
    • Those for USACO are automatically generated.
  • Adding editorials.
    • If no editorial exists, or if existing editorial could be improved.
    • Or solution code in a different language, etc.

Writing Content

All modules are written in MDX (Markdown + JSX), with limited LaTeX\LaTeX support from KaTeX and some custom components. You can check how an .mdx file renders by pasting it in the live editor.

See the Content Documentation for more info.

Useful Links

Adding a Solution

  1. Fork the GitHub repository.

  2. If it doesn't already exist, create a new mdx file in solutions including frontmatter, ex. the following in USACO jan17-cow-dance-show.mdx:

    ---
    id: usaco-690
    source: USACO Silver 2017 January
    title: Cow Dance Show
    author: Óscar Garries
    ---
    
    [Official Analysis](http://www.usaco.org/current/data/sol_cowdance_silver_jan17.html)
    
    <LanguageSection>
    
    <CPPSection>
    
    **Time Complexity:** $\mathcal{O}(N\log^2N)$
    
    ^ Format time complexity like this.
    
    (add C++ code + explanation here ...)
    
    Use `\texttt{}` around variable names with length greater than one, like so. Place long equations on separate lines with display math, and use `\cdot` instead of `*` to denote multiplication.
    
    $$
    \texttt{arr}[i]=2\cdot (a+b+c+d+e)+\sum_{j=0}^{i-1}\texttt{arr}[j]
    $$
    
    </CPPSection>
    
    <PySection>
    
    (if you have Python code)
    
    </PySection>
    
    <JavaSection>
    
    (if you have Java code)
    
    </JavaSection>
    
    </LanguageSection>
    

    It is not necessary to add an alternative implementation in the same language as the official analysis (unless the alternative implementation takes a different approach or is written better / differently from the official implementation).

    Keep file names and solution IDs consistent; namely, USACO IDs should correspond to the URL on usaco.org.

  3. Add the solution ID (ex. usaco-690) as the last argument of the Problem constructor in the corresponding module (in this case, Binary_Search_Ans.mdx). Also add tags (if you want).

    new Problem(
      'Silver',
      'Cow Dance Show',
      '690',
      'Easy',
      false,
      ['tag1', 'tag2'],
      'usaco-690'
    ),
    
  4. Check that both the module and the solution render properly using the live editor before submitting a pull request.

Module Progress:

Join the USACO Forum!

Stuck on a problem, or don't understand a module? Join the USACO Forum and get help from other competitive programmers!

Give Us Feedback on Contributing!

Leave suggestions for us by making a post on the USACO Forum! Ex: Unclear sections, mislabeled problems, etc.