Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

This is a Jekyll/GitHub Pages site based on the Academic Pages/Minimal Mistakes theme. Core site configuration lives in _config.yml; local-development overrides may use _config.dev.yml. Content pages are in _pages/, blog posts are in _posts/ using YYYY-MM-DD-title.md, shared templates are in _layouts/ and _includes/, data files are in _data/, styles are in _sass/, and public static assets live under assets/ and images/. Generated output in _site/, caches such as .jekyll-cache/, and dependency folders are not source files.

Build, Test, and Development Commands

  • bundle exec jekyll build: build the site with the Gemfile dependency set.
  • $env:JEKYLL_NO_BUNDLER_REQUIRE='true'; jekyll build: useful on this Windows setup when local Bundler dependencies are unavailable.
  • python -m http.server 4000 --directory _site: serve the built site at http://localhost:4000/.
  • npm run build:site: build via the Docker-based script in package.json.
  • npm run serve:site: serve _site/ with Python.

Treat a successful Jekyll build plus a browser smoke check of the homepage and changed pages as the baseline test.

Coding Style & Naming Conventions

Use Markdown with YAML front matter for content. Keep front matter keys lowercase where possible, indent YAML lists by two spaces, and prefer explicit permalink values for menu pages. Name posts with Jekyll’s date prefix pattern, for example _posts/2026-02-25-R-python.md. Keep Liquid templates small and reuse includes rather than duplicating markup. For SCSS, edit partials in _sass/; do not edit generated CSS in _site/.

Testing Guidelines

There is no dedicated automated test framework. Before committing, run a full build and inspect relevant generated pages locally. For layout changes, check both the homepage and at least one non-home page. For content changes, verify links, dates, headings, and rendered Markdown.

Commit & Pull Request Guidelines

Recent commits use short, direct subjects such as update papers, hide left sidebar, and clean up by AI. Follow that style: imperative, concise, and focused on one change. Pull requests should include a short summary, affected pages or directories, build result, and screenshots for visible layout changes.

Agent-Specific Instructions

Do not edit _site/ as source. Do not commit generated caches, Gemfile.lock, or OS files. Preserve existing content encoding and avoid broad theme refactors unless the user explicitly requests them.