Skip to content

TEMPLATE.md

Latest commit

 

History

History
40 lines (34 loc) · 2.25 KB

TEMPLATE.md

File metadata and controls

40 lines (34 loc) · 2.25 KB
Raw

Using this template

This repository is a project template. When you create a new repository from it, replace the placeholder tokens below and complete the setup steps. Tokens use the {{UPPER_SNAKE}} form and appear in README.md, CITATION.cff, SECURITY.md, LICENSE, and docs/social_preview.svg.

Placeholder tokens

Token Meaning
{{PROJECT_NAME}} Human-readable project title.
{{TAGLINE}} One-line summary shown under the title.
{{STATUS}} Lifecycle badge text: Active or Archived.
{{YEAR}} Copyright and release year.
{{CONTEXT}} Course, thesis, or research context.
{{ABSTRACT}} Short abstract for CITATION.cff.
{{KEYWORDS}} Citation keywords, one per line as a keywords: sequence item in CITATION.cff.
{{BADGE_LABEL}} Social-preview badge text; a short label such as ACADEMIC ARCHIVE. Long text overflows the fixed-width badge.
{{REPO_SLUG}} Repository name — the name half of the owner/name slug; the owner is already fixed in the URLs.

The README body also carries free-form section tokens filled with prose rather than short values: {{FEATURE}}, {{ARCHITECTURE}}, {{TECH_STACK}}, {{TREE}}, {{GETTING_STARTED}}, {{DOCUMENTATION}}, {{REFERENCES}}.

Setup steps

  1. Replace every {{TOKEN}} across README.md, CITATION.cff, SECURITY.md, LICENSE, and docs/social_preview.svg; confirm none remain with git grep '{{'.
  2. Set {{STATUS}} to Active or Archived, and align CONTRIBUTING.md accordingly: an active project accepts contributions; an archive does not.
  3. Replace the placeholder icon group in docs/social_preview.svg with a bespoke line-art glyph for the project, then regenerate the social-preview images with ./docs/render.sh (requires Node, ImageMagick, and Google Chrome) and upload docs/social_card.png under the repository's Settings → Social preview.
  4. Add the project's dependency ecosystem to .github/dependabot.yml and the build and test steps to .github/workflows/ci.yml.
  5. Add stopwords for any disclosed demo credentials to .gitleaks.toml.
  6. Configure repository settings: Issues enabled for an active project and disabled for an archive; leave Wiki and Projects off unless used.