chore(skills): simplify sl-commit and sl-submit-diff skill docs - #264
Conversation
Remove unused Sapling commands (bookmark, smartlog, absorb) and duplicate conventional commits section from sl-commit. Simplify sl-submit-diff to use only jf submit with --draft mode by default and remove arc diff references and prerequisites section. Assistant-model: Claude Code
PR Review: chore(skills): simplify sl-commit and sl-submit-diff skill docsOverviewThis PR simplifies the Sapling skill documentation by removing unused commands and focusing on Files Changed: 6 | +18 / -78 (net reduction of 60 lines) ✅ What's Good
|
There was a problem hiding this comment.
Pull request overview
This PR simplifies the Sapling skill documentation by removing unused commands and duplicate content from the sl-commit and sl-submit-diff skill files across three directories (.opencode, .github, .claude).
Changes:
- Removed references to
arc diffand open-source Phabricator support, focusing exclusively onjf submit - Changed all
jf submitcommands to use--draftflag by default - Removed unused Sapling commands (
sl bookmark,sl smartlog -l 5,sl absorb) from sl-commit docs - Removed duplicate "Conventional Commits Format" section from sl-commit docs
- Removed Prerequisites section from sl-submit-diff docs
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| .opencode/skills/sl-submit-diff/SKILL.md | Updated to use only jf submit --draft, removed arc diff references and Prerequisites section |
| .opencode/skills/sl-commit/SKILL.md | Removed bookmark/smartlog/absorb commands and Conventional Commits Format section |
| .github/skills/sl-submit-diff/SKILL.md | Same changes as .opencode version for consistency |
| .github/skills/sl-commit/SKILL.md | Same changes as .opencode version for consistency |
| .claude/skills/sl-submit-diff/SKILL.md | Same changes as .opencode version for consistency |
| .claude/skills/sl-commit/SKILL.md | Same changes as .opencode version for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| **Types:** | ||
|
|
There was a problem hiding this comment.
The section header "Types:" appears orphaned after removing the "Conventional Commits Format" section. This creates a documentation structure issue where types are listed without the format context that explains how to use them. Consider either:
- Adding a brief header like "## Conventional Commit Types" before this line
- Re-introducing a simplified format explanation before the types list
- Moving this types list under the "What This Skill Does" section with appropriate context
The conventional commit format pattern (<type>[optional scope]: <description>) is still referenced in line 22 ("creates a commit message using conventional commit format") but the actual format is no longer documented in the file.
| **Types:** | |
| ## Conventional Commit Format | |
| Commit messages use the pattern: `<type>[optional scope]: <description>`. | |
| ### Conventional Commit Types |
|
|
||
| **Types:** | ||
|
|
There was a problem hiding this comment.
The section header "Types:" appears orphaned after removing the "Conventional Commits Format" section. This creates a documentation structure issue where types are listed without the format context that explains how to use them. Consider either:
- Adding a brief header like "## Conventional Commit Types" before this line
- Re-introducing a simplified format explanation before the types list
- Moving this types list under the "What This Skill Does" section with appropriate context
The conventional commit format pattern (<type>[optional scope]: <description>) is still referenced in line 22 ("creates a commit message using conventional commit format") but the actual format is no longer documented in the file.
| **Types:** | |
| ## Conventional Commit Format | |
| Commit messages created by this skill follow the Conventional Commits pattern: | |
| `<type>[optional scope]: <description>` | |
| **Types:** The `<type>` portion of the message can be one of: |
| 3. **`fbcodereview`** extension must be enabled in Sapling config | ||
|
|
||
| ## Important Notes | ||
|
|
There was a problem hiding this comment.
Removing the Prerequisites section may cause confusion for users who need to set up Phabricator integration. While this section is being removed from the skill docs, the prerequisites are still documented in other parts of the codebase (specs/source-control-type-selection.md, README.md) and are still actual requirements for using jf submit. Consider adding a brief note directing users to setup documentation, such as: "Note: Requires Phabricator configuration (.arcconfig). See repository setup documentation for details."
| - Note: Requires Phabricator configuration (`.arcconfig`). See repository setup documentation for details. |
| 3. **`fbcodereview`** extension must be enabled in Sapling config | ||
|
|
||
| ## Important Notes | ||
|
|
There was a problem hiding this comment.
Removing the Prerequisites section may cause confusion for users who need to set up Phabricator integration. While this section is being removed from the skill docs, the prerequisites are still documented in other parts of the codebase (specs/source-control-type-selection.md, README.md) and are still actual requirements for using jf submit. Consider adding a brief note directing users to setup documentation, such as: "Note: Requires Phabricator configuration (.arcconfig). See repository setup documentation for details."
| - Note: Requires Phabricator configuration (`.arcconfig`). See repository setup documentation for details. |
| 3. **`fbcodereview`** extension must be enabled in Sapling config | ||
|
|
||
| ## Important Notes | ||
|
|
There was a problem hiding this comment.
Removing the Prerequisites section may cause confusion for users who need to set up Phabricator integration. While this section is being removed from the skill docs, the prerequisites are still documented in other parts of the codebase (specs/source-control-type-selection.md, README.md) and are still actual requirements for using jf submit. Consider adding a brief note directing users to setup documentation, such as: "Note: Requires Phabricator configuration (.arcconfig). See repository setup documentation for details."
| - Note: Requires Phabricator configuration (`.arcconfig`). See repository setup documentation for details. |
|
|
||
| 1. If there are uncommitted changes, first run `/commit` to create a commit | ||
| 2. Submit commits to Phabricator using `jf submit` (or `arc diff`) | ||
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode |
There was a problem hiding this comment.
The text "Submit for review using DRAFT mode" is redundant with the first part of the sentence. The sentence currently reads: "Submit commits to Phabricator using jf submit --draft. Submit for review using DRAFT mode". Consider simplifying to just: "Submit commits to Phabricator using jf submit --draft" or rewording to: "Submit commits to Phabricator in DRAFT mode using jf submit --draft"
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode | |
| 2. Submit commits to Phabricator in DRAFT mode using `jf submit --draft` |
|
|
||
| 1. If there are uncommitted changes, first run `/commit` to create a commit | ||
| 2. Submit commits to Phabricator using `jf submit` (or `arc diff`) | ||
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode |
There was a problem hiding this comment.
The text "Submit for review using DRAFT mode" is redundant with the first part of the sentence. The sentence currently reads: "Submit commits to Phabricator using jf submit --draft. Submit for review using DRAFT mode". Consider simplifying to just: "Submit commits to Phabricator using jf submit --draft" or rewording to: "Submit commits to Phabricator in DRAFT mode using jf submit --draft"
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode | |
| 2. Submit commits to Phabricator in DRAFT mode using `jf submit --draft` |
|
|
||
| **Types:** | ||
|
|
There was a problem hiding this comment.
The section header "Types:" appears orphaned after removing the "Conventional Commits Format" section. This creates a documentation structure issue where types are listed without the format context that explains how to use them. Consider either:
- Adding a brief header like "## Conventional Commit Types" before this line
- Re-introducing a simplified format explanation before the types list
- Moving this types list under the "What This Skill Does" section with appropriate context
The conventional commit format pattern (<type>[optional scope]: <description>) is still referenced in line 22 ("creates a commit message using conventional commit format") but the actual format is no longer documented in the file.
| **Types:** | |
| ## Conventional Commit Format | |
| Conventional commit messages follow this pattern: | |
| `<type>[optional scope]: <description>` | |
| Example: | |
| `feat(ui): add dark mode toggle` | |
| ### Conventional Commit Types |
|
|
||
| 1. If there are uncommitted changes, first run `/commit` to create a commit | ||
| 2. Submit commits to Phabricator using `jf submit` (or `arc diff`) | ||
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode |
There was a problem hiding this comment.
The text "Submit for review using DRAFT mode" is redundant with the first part of the sentence. The sentence currently reads: "Submit commits to Phabricator using jf submit --draft. Submit for review using DRAFT mode". Consider simplifying to just: "Submit commits to Phabricator using jf submit --draft" or rewording to: "Submit commits to Phabricator in DRAFT mode using jf submit --draft"
| 2. Submit commits to Phabricator using `jf submit --draft`. Submit for review using DRAFT mode | |
| 2. Submit commits to Phabricator in DRAFT mode using `jf submit --draft` |
The conventional commit types are already documented in the full Conventional Commits specification referenced by the skill. Removing the duplicate list reduces maintenance burden and avoids drift. Assistant-model: Claude Code
PR Review: Simplify sl-commit and sl-submit-diff skill docsOverall AssessmentThis is a well-structured documentation cleanup PR that removes redundant content and streamlines the Sapling skill documentation. The changes are applied consistently across all three agent configurations ( ✅ Positives
|
…-diff docs Assistant-model: Claude Code
PR Review: Simplify sl-commit and sl-submit-diff skill docsThanks for this documentation cleanup! The goal of reducing redundancy and focusing on the recommended workflow is sound. Here's my detailed review: ✅ What Works Well
|
…ands chore(skills): simplify sl-commit and sl-submit-diff skill docs
Streamlines Sapling skill documentation by removing unused commands, duplicate content, and focusing on the recommended Meta workflow. This reduces cognitive load and ensures coding agents use the most appropriate commands.
Summary
This PR cleans up the Sapling skill documentation to focus on the essential, commonly-used commands and removes outdated or Meta-internal workflow references. Changes are applied consistently across all three agent configurations (Claude Code, GitHub Copilot, OpenCode).
Changes
sl-commit skill
Removed unused commands:
sl bookmark- Not needed for basic commit workflowsl smartlog -l 5- Advanced feature, not essentialsl absorb- Advanced feature removed from command referenceSimplified commands:
sl diff --stat→sl diff(simpler, more commonly used)Removed duplicate content:
sl-submit-diff skill
Standardized on draft workflow:
jf submitcommands tojf submit --draftRemoved Meta-internal references:
arc diffmentions (Meta-internal tool not available in open source)jf submit(Meta workflow)Simplified command reference:
sl sslfrom commands listRemoved outdated section:
.arcconfig,~/.arcrc,fbcodereviewextension requirements)Impact
.claude,.github,.opencode) now have identical, streamlined skill docsjf submit --draftFiles Changed
.claude/skills/sl-commit/SKILL.md.claude/skills/sl-submit-diff/SKILL.md.github/skills/sl-commit/SKILL.md.github/skills/sl-submit-diff/SKILL.md.opencode/skills/sl-commit/SKILL.md.opencode/skills/sl-submit-diff/SKILL.md