usaco-guide icon indicating copy to clipboard operation
usaco-guide copied to clipboard

Conventions for Problem Sources & Tags

Open bqi343 opened this issue 3 years ago • 4 comments

  • update (source -> tooltip) mapping as @dolphingarlic mentioned
  • make sure existing sources / tags follow conventions (ex. #1730, https://github.com/cpinitiative/usaco-guide/pull/1657#issuecomment-860261282)
  • note conventions for sources / tags somewhere

bqi343 avatar Jun 13 '21 20:06 bqi343

@cpinitiative/content-managers do we note these conventions anywhere?

thecodingwizard avatar Oct 20 '21 21:10 thecodingwizard

"adding solution" maybe

SansPapyrus683 avatar Oct 26 '21 23:10 SansPapyrus683

is this still a problem?

SansPapyrus683 avatar Apr 24 '22 17:04 SansPapyrus683

Some concrete conventions:

Sources:

  • Use the existing sources in https://github.com/cpinitiative/usaco-guide/blob/20d696c1306947a054c41b1d3554f9a6a5515064/src/models/problem.ts#L6 when possible.

Tags

  • Leave the list of tags blank as opposed to adding "Ad Hoc" as a tag.
  • Use existing tags when possible, capitalize new tags in the same way as previous tags.
  • Split separate tags into separate strings (e.g., ['Meet in the Middle', 'DP'] rather than ['Meet in the Middle, DP']).

"adding solution" maybe

Probably https://usaco.guide/general/modules?lang=cpp#practice-problems would be more suitable, since "Adding Solution" doesn't include adding problems.

is this still a problem?

Yes in the sense that the tag conventions are violated with some frequency (check the LHS of https://usaco.guide/problems/). Not sure about the others.

bqi343 avatar Jun 18 '22 19:06 bqi343