Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (23 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1.28 KB
Raw

Contributing

Thanks for helping improve Programación Competitiva CUNEF! Contributions from students and faculty are very welcome — code, fixes, explanations, or just ideas.

📖 Full step-by-step guide (Spanish): https://jparisu.github.io/PrograCompetitivaCUNEF/contributing/

Quick links

In short

  • Each element (algorithm / technique / structure) is one folder under docs/content/<topic>/<id>/.

  • Write the hand-written full code (C++ and Python) and fill <id>.meta.yaml; the clean/contest versions, tests, tables, graph and the site navigation are generated — you never edit mkdocs.yml by hand.

  • Before opening a PR:

    pip install -r tools/requirements.txt
python tools/gen.py generate   # create/update derived files
python tools/gen.py status     # must say "up to date"

See the online guide for the complete walkthrough (Git basics, adding an algorithm, images/gifs, and the project scripts).