Repository Guidelines

Project Structure & Module Organization

This repository is a Jekyll site (Minimal Mistakes-based). Edit source files, not generated output.

• Main content: _posts/ (blog posts by category and date)
• Custom collections: _obspycollection/, _methods-algorithms/, _plotting-tutorial/, _downloads/
• Shared templates and UI: _includes/, _layouts/, _sass/, assets/, custom-css/, custom-js/
• Site configuration/data: _config.yml, _data/
• Static media/docs: images/, downloads/, docs/, Attachments/
• Generated site (do not edit directly): _site/

Build, Test, and Development Commands

• bundle install: install Ruby dependencies from Gemfile.
• bundle exec jekyll serve --livereload: run local dev server with live reload.
• bundle exec jekyll build: production-style build into _site/.
• npm install: install Node tooling for JS asset pipeline.
• npm run build:js: rebuild assets/js/main.min.js and apply banner.
• npm run watch:js: watch JS source changes and rebuild automatically.

Coding Style & Naming Conventions

• Markdown files use YAML front matter and clear section headings.
• Post filenames follow YYYY-MM-DD-title.md; keep slugs lowercase and hyphenated.
• Use 2-space indentation in YAML and front matter blocks.
• Keep reusable markup in _includes/; avoid duplicating layout logic across posts/pages.
• Edit JS source in assets/js/_main.js and plugins, then regenerate minified output with npm run build:js.

Testing Guidelines

There is no dedicated automated test suite configured. Use build validation plus manual smoke testing:

• Run bundle exec jekyll build before opening a PR.
• Start bundle exec jekyll serve --livereload and verify changed pages, navigation, and assets.
• For JS changes, run npm run build:js and confirm no console errors in the browser.

Commit & Pull Request Guidelines

Current history favors short, imperative commit subjects (for example: new post, figure update, post update).

• Write concise, imperative commit messages and include scope when useful (example: posts: add MH tutorial).
• Keep PRs focused; include a short summary, affected paths, and verification steps.
• Attach screenshots for visual/layout changes and link related issues if applicable.
• Do not commit _site/ rebuild-only changes unless explicitly required.