Contributing to This Wiki

Who this is for: anyone who edits this wiki. Every lab member is welcome to fix what is wrong or unclear.

Small fixes

Use the Edit button on the page. Describe the change in the edit message.

Larger changes

Clone the wiki, edit the Markdown files, and push:

git clone https://github.com/EpiModel/EpiModeling.wiki.git

The wiki's branch is master. One file is one page; the file name is the page title with spaces replaced by hyphens.

Page names

• Use Title Case and plain words. Do not put " - ", backticks, or other punctuation in a title: GitHub stores a hyphen in a title as a special Unicode character that nobody can type in a URL. (Two older pages, EpiModelHIV ‐ code conventions and EpiModelHIV ‐ New Parameters and Attributes, have such a hyphen. Issue templates in many repositories link to them, so we keep their names.)
• Renaming a page does not redirect its old address. Before renaming, search for links to it (this wiki, _Sidebar.md, and repositories such as EpiModelHIV-Template). If other repositories link to it, leave a short page at the old name that points to the new one.
• Add every new page to Home and _Sidebar.md.
• The headings "ARTnetData", "HPC setup", "slurmworkflow", and "TERGM" on Home are linked from the EpiModelHIV-Template README and project repositories. Do not rename them. The same goes for the "Adding New Parameters" and "Adding New Attributes" headings on the parameters page, which issue templates link to.

Links

• To another wiki page, use a double-bracket link with the link text first and the page's file name (without .md) second, optionally followed by a section anchor:

  [[Link text|Page-Name]]
  [[Link text|Page-Name#section]]
  

• Do not use wiki/Page-Name or a full github.com/.../wiki/... address for our own pages; those break from some pages.

• To a file in another repository that should follow its default branch, use blob/HEAD/ in the address.

• Prefer linking to the source (a package vignette, a template README) over copying text that will go out of date.

Writing style

• Start each page with one line: who it is for and what to read first.
• End HPC and tutorial pages with a "Next:" link to the following page in the learning path.
• Start sections at ## (the page title is the top heading).
• Write each paragraph and each list item on one line; let the browser wrap it.
• Use "we" for the lab and "you" for the reader. American spelling. Dates as 10/12/26 or October 12, 2026.
• Put commands in fenced code blocks with a language tag (bash, r), and output in text blocks. Use placeholders such as <netid> instead of a real username.
• When a version or partition name will change, say "as of ".