You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document outlines the conventions for using Git and writing commit messages in this project.
4
+
5
+
## Commit Message Format
6
+
7
+
All commit messages should follow this format:
8
+
9
+
```
10
+
<type>: <subject>
11
+
12
+
<body (optional)>
13
+
```
14
+
15
+
**Types:**
16
+
17
+
-`feat`: A new feature
18
+
-`fix`: A bug fix
19
+
-`docs`: Documentation only changes
20
+
-`style`: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
21
+
-`config`: Changes to configuration files
22
+
-`chore`: Changes to the build process or auxiliary tools and libraries
23
+
24
+
**Examples:**
25
+
26
+
```
27
+
feat: Add dark mode toggle button to header
28
+
fix: Correct baseurl in project site configuration
29
+
docs: Update INSTALL.md with Docker troubleshooting
30
+
style: Format all Liquid templates with Prettier
31
+
config: Enable blog section in _config.yml
32
+
chore: Update Jekyll dependencies with bundle update --all
33
+
```
34
+
35
+
## Staging Changes
36
+
37
+
**Always `git add` files explicitly.** Do not stage everything with `git add .` unless you are certain of what's being committed. Check `git status` first to review your changes.
38
+
39
+
## What NOT to Commit
40
+
41
+
**Always obey the project's [`.gitignore`](../.gitignore) file.** It prevents the accidental commit of:
- Creating pages, blog posts, projects, news items
95
+
- CV information (RenderCV and JSONResume formats)
96
+
- Creating pages, blog posts, projects, news items, and teaching pages
62
97
- Publications and BibTeX management
63
98
- Theme colors and styling
64
99
- Social media setup
100
+
- Search and analytics configuration
65
101
- Removing unwanted content
66
102
- Font and spacing customization
67
-
3.**INSTALL.md** – Installation and deployment instructions
68
-
4.**FAQ.md** – Common issues and solutions
103
+
- Newsletter setup
104
+
- Google Calendar integration
105
+
5.**FAQ.md** – Frequently asked questions and common solutions
106
+
6.**TROUBLESHOOTING.md** – Troubleshooting guide for common issues
107
+
7.**CONTRIBUTING.md** – Guidelines for contributing to the project
108
+
109
+
8.**ANALYTICS.md** – Analytics and tracking configuration
110
+
9.**SEO.md** – Search engine optimization guide
111
+
112
+
## Custom Instructions Context
113
+
114
+
This repository maintains custom instruction files (in `.github/instructions/` and `.github/copilot-instructions.md`) to guide Copilot agents when working with specific file types. These instructions provide:
115
+
116
+
-**Build process and requirements** – Docker setup, Ruby/Python versions, dependency management
-**Common patterns and examples** – How to modify configuration, create content, and implement features
120
+
-**Common pitfalls and workarounds** – Solutions to frequent issues like YAML syntax errors, CSS/JS not loading, broken links
121
+
122
+
When helping users, reference these instructions to ensure recommendations align with project conventions and best practices. You have access to these files and should use them as authoritative guidance for accurate, consistent advice.
-**Choose your format:** Users select either RenderCV (`_data/cv.yml`) or JSONResume (`assets/json/resume.json`) — they pick ONE format
140
-
-**Delete the unused format:** Remove the file for the format you're not using (so only one source exists) if you want to avoid confusion
141
-
-**RenderCV features:** Automatic PDF generation via GitHub Actions, customizable styling via `assets/rendercv/` config files (`design.yaml`, `locale.yaml`, `settings.yaml`)
142
-
-**JSONResume features:** Standard format compatible with other tools and services
143
-
-**Switching formats:** Users can change which format displays on the CV page by editing the `cv_format` setting in `_pages/cv.md` frontmatter
144
-
-**Note about both files:** Both files exist in the repository for template flexibility, but users usually only maintain the one they choose
193
+
-**Choose your format:** Users can maintain either RenderCV (`_data/cv.yml`) or JSONResume (`assets/json/resume.json`), or both simultaneously
194
+
-**RenderCV (recommended):** Human-readable YAML format with automatic PDF generation via GitHub Actions, customizable styling via `assets/rendercv/` config files (`design.yaml`, `locale.yaml`, `settings.yaml`)
195
+
-**JSONResume:** Standard JSON format compatible with other tools and services
196
+
-**Using both formats:** Users can keep both files and switch which one displays using the `cv_format` frontmatter variable in `_pages/cv.md` (options: `rendercv` or `jsonresume`)
197
+
-**Single format:** To use only one format, optionally delete the unused file (both are supported equally well)
145
198
146
199
### 5. Publications
147
200
@@ -177,28 +230,38 @@ npx prettier . --write
177
230
- Add inline announcements or news with links
178
231
- Automatically displayed on home page
179
232
180
-
### 9. Theme Colors
233
+
### 9. Teaching Pages
234
+
235
+
**Files:**`_teachings/*.md`
236
+
237
+
- Create course and teaching pages in `_teachings/` directory
238
+
- Add frontmatter: layout, title, description, academic_year, type
0 commit comments