Skip to content

Commit 6613820

Browse files
authored
Merge branch 'main' into github-slack-action-pin-to-exact-version
2 parents 8f3fa5f + b0a1d51 commit 6613820

File tree

258 files changed

+6420
-1735
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

258 files changed

+6420
-1735
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

.agents/skills/commit/SKILL.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: commit
3+
description: Commit message formatting and guidelines
4+
---
5+
6+
# Commit
7+
8+
Use this skill whenever the user asks you to create a git commit for the current work.
9+
10+
## Instructions
11+
12+
1. Review the current git state before committing:
13+
- `git status`
14+
- `git diff`
15+
- `git log -5 --oneline`
16+
2. Only stage files relevant to the requested change. Do not include unrelated untracked files, generated files, or likely-local artifacts.
17+
3. Always follow Ghost's commit conventions (see below) for commit messages
18+
4. Run `git status --short` after committing and confirm the result.
19+
20+
## Important
21+
- Do not push to remote unless the user explicitly asks
22+
- Keep commits focused and avoid bundling unrelated changes
23+
- If there are no relevant changes, do not create an empty commit
24+
- If hooks fail, fix the issue and create a new commit. Never bypass hooks.
25+
26+
## Commit message format
27+
28+
We have a handful of simple standards for commit messages which help us to generate readable changelogs. Please follow this wherever possible and mention the associated issue number.
29+
30+
- **1st line:** Max 80 character summary
31+
- Written in past tense e.g. “Fixed the thing” not “Fixes the thing”
32+
- Start with one of: Fixed, Changed, Updated, Improved, Added, Removed, Reverted, Moved, Released, Bumped, Cleaned
33+
- **2nd line:** [Always blank]
34+
- **3rd line:** `ref <issue link>`, `fixes <issue link>`, `closes <issue link>` or blank
35+
- **4th line:** Why this change was made - the code includes the what, the commit message should describe the context of why - why this, why now, why not something else?
36+
37+
If your change is **user-facing** please prepend the first line of your commit with **an emoji**.
38+
39+
Because emoji commits are the release notes, it's important that anything that gets an emoji is a user-facing change that's significant and relevant for end-users to see.
40+
41+
The first line of an emoji commit message should be from the perspective of the user. For example, 🐛 Fixed a race condition in the members service is technical and tells the user nothing, but 🐛 Fixed a bug causing active members to lose access to paid content tells the user reading the release notes “oh yeah, they fixed that bug I kept hitting.”
42+
43+
### Main emojis we are using:
44+
45+
- ✨ Feature
46+
- 🎨 Improvement / change
47+
- 🐛 Bug Fix
48+
- 🌐 i18n (translation) submissions
49+
- 💡 Anything else flagged to users or whoever is writing release notes
50+
51+
### Example
52+
53+
```
54+
✨ Added config flag for disabling page analytics
55+
56+
ref https://linear.app/tryghost/issue/ENG-1234/
57+
58+
- analytics are brand new under development, therefore they need to be behind a flag
59+
- not using the developerExperiments flag as that is already in wide use and we aren't ready to deploy this anywhere yet
60+
- using the term `pageAnalytics` as this was discussed as best reflecting what this does
61+
```
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)