Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

This repository is an Academic Pages/Jekyll site. Site configuration lives in _config.yml; content pages live in _pages/; collection items live in _publications/, _talks/, _teaching/, _portfolio/, and _posts/. Shared templates are in _layouts/ and _includes/. Styles are SCSS partials under _sass/, with generated CSS under assets/css/. JavaScript sources are in assets/js/. Static assets belong in images/ and downloadable papers or BibTeX files belong in files/. Generated output in _site/ and cache folders such as .sass-cache/ should not be edited directly.

Build, Test, and Development Commands

  • bundle install: install Ruby/Jekyll dependencies from Gemfile.
  • bundle exec jekyll serve -l -H localhost: run the local site at http://localhost:4000 with live reload.
  • bundle exec jekyll build: build the site into _site/; use this as the main validation step before committing.
  • npm install: install JavaScript dependencies when updating bundled assets.
  • npm run build:js: minify JavaScript into assets/js/main.min.js.
  • docker compose up: run the site through the provided Docker setup when local Ruby setup is inconvenient.

Coding Style & Naming Conventions

Use Markdown with YAML front matter for content files. Publication files should use date-prefixed, lowercase, hyphenated names, for example _publications/2025-11-21-vgpnet-a-vision-aided-gnss-positioning-framework-with-cross-channel-feature-fusion-for-urban-canyons.md. Keep front matter keys consistent with existing entries: title, collection, category, permalink, excerpt, date, venue, paperurl, and citation. Use two-space indentation in YAML and SCSS nesting where indentation is needed. Prefer concise, relative links for local assets, such as /files/paper.pdf.

Testing Guidelines

There is no separate automated test suite. Validate changes with bundle exec jekyll build and inspect the affected page locally with bundle exec jekyll serve -l -H localhost. For content changes, check that generated links, dates, citations, and PDF paths render correctly.

Commit & Pull Request Guidelines

The visible history only contains an initial commit, so use clear imperative commit messages such as Add VGPNet publication entry or Update site navigation. Pull requests should describe the changed pages or assets, include screenshots for visual/layout changes, mention any linked issue, and confirm that bundle exec jekyll build passes.

Security & Configuration Tips

Do not commit secrets, API keys, or private drafts. Verify _config.yml values such as url, repository, analytics IDs, and social links before publishing. Keep large downloadable files in files/ and avoid modifying generated _site/ files.