Skip to content

chore(deps): update agent skills (plugins/engineering-practices/skills/write-readme) #608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devantler merged 2 commits into from
Oct 26, 2026
Merged

chore(deps): update agent skills (plugins/engineering-practices/skills/write-readme) #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4be6c1
chore(deps): update agent skills (plugins/engineering-practices/skill…
botantler-1[bot] Oct 26, 2026
0afaf12
chore(deps): refresh plugin metadata for synced content
botantler-1[bot] Oct 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/marketplace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
{
"name": "engineering-practices",
"description": "Git commits, conventional releases, refactoring, test-driven development, and engineering ways of working skills",
"version": "1.1.5",
"version": "1.1.6",
"source": "./plugins/engineering-practices"
},
{
Expand Down
2 changes: 1 addition & 1 deletion .github/plugin/marketplace.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
{
"name": "engineering-practices",
"description": "Git commits, conventional releases, refactoring, test-driven development, and engineering ways of working skills",
"version": "1.1.5",
"version": "1.1.6",
"source": "./plugins/engineering-practices"
},
{
Expand Down
2 changes: 1 addition & 1 deletion plugins/engineering-practices/.claude-plugin/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "engineering-practices",
"description": "Git commits, conventional releases, refactoring, test-driven development, and engineering ways of working skills",
"version": "1.1.5",
"version": "1.1.6",
"author": {
"name": "devantler-tech",
"url": "https://github.com/devantler-tech"
Expand Down
4 changes: 4 additions & 0 deletions plugins/engineering-practices/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog — `engineering-practices`

## 1.1.6 — 2026-10-26

**Changed** — sync `write-readme` from `https://github.com/devantler-tech/agent-skills` at `refs/tags/v1.28.1`.

## 1.1.5 — 2026-10-25

**Changed** — sync `git-commit` from `https://github.com/github/awesome-copilot` at `e24be77e6f203409cf99ab7d5a67e1540cb386d3`.
Expand Down
2 changes: 1 addition & 1 deletion plugins/engineering-practices/plugin.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "engineering-practices",
"description": "Git commits, conventional releases, refactoring, test-driven development, and engineering ways of working skills",
"version": "1.1.5",
"version": "1.1.6",
"author": {
"name": "devantler-tech",
"url": "https://github.com/devantler-tech"
Expand Down
8 changes: 6 additions & 2 deletions plugins/engineering-practices/skills/write-readme/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ description: Write or improve a newcomer-facing README with a clear product over
license: Apache-2.0
metadata:
github-path: write-readme
github-ref: refs/tags/v1.24.1
github-ref: refs/tags/v1.28.1
github-repo: https://github.com/devantler-tech/agent-skills
github-tree-sha: 02451fe8f1c139a29ad1a404dc1f0abc5c0e0c8f
github-tree-sha: f5de4610a39834eefc9c25ae8e1c80b66e0914d3
name: write-readme
---
# Write a useful README
Expand All @@ -31,6 +31,10 @@ product, not its development history. Use short paragraphs, familiar words and c
Keep names readers use to recognize compatibility: “Encrypt secrets with SOPS” is clearer than
either a bare tool list or a long explanation of encryption internals.

Draw any diagram as a Mermaid block, which GitHub renders, never as ASCII art or box-drawing
characters: fixed-width drawings overflow phone screens and screen readers read them as noise.
Prefer a top-down layout with short labels, and keep any directory tree short and narrow.

Use bullets for distinct benefits and a compact table when comparison helps. Keep a useful feature
overview visible; do not move every reason to choose the product into a reference document. Avoid
repeating the introduction, explaining every technical noun, or adding warnings for hypothetical
Expand Down
Loading