PR Submission Conventions
Standardize pull request titles, commit messages, and pre-PR checklist for the SkillHub project to keep contributions consistent.
The skill is documentation-oriented, with no external side effects or sensitive data handling, so no red-line risk, but it lacks user confirmation mechanisms and rollback steps, and the publisher identity is unverified, limiting source trust.
Commands and checklist are self-consistent, but rely on repository scripts and CI; no isolated tests are provided; static review cannot verify key paths, and error handling is limited, hence low score.
Target scenario is clear (PR submission workflow), but capability boundaries and non-fit scenarios are not declared; trigger precision is limited to description, and environment fit (Chinese support, network) is not addressed.
Well-structured with type tables, examples, and checklist, but lacks installation instructions, versioning, changelog, and maintenance responsibility; license is declared in frontmatter but no detailed usage docs.
Can guide users through PR submission, but lacks evidence of actual output verification and comparative benefit; marginal value over manual effort is limited, hence low score.
No independent reproducible tests or third-party verification; relies only on repository files; static review cannot confirm actual execution, hence low score.
- Publisher identity is unverified, limiting source trust
- Skill provides guidance only, lacks execution and rollback mechanisms; user confirmation is required
- No mention of Chinese support or network reachability, may not suit Chinese user environments
What does this skill do, and when should you use it?
This skill provides guidance for creating pull requests in the SkillHub repository. It defines conventional commit style for PR titles and commit messages, including types like feat, fix, docs, test, refactor, and chore, along with scopes such as auth, search, publish, and governance. It also includes a pre-PR checklist with specific make commands, a PR body structure template, and review conventions that reference architecture rules.
The skill provides rules and templates for: formatting PR titles based on change type and scope; writing commit messages using conventional commit style; running pre-PR checks (e.g., make test-backend-app, make typecheck-web, make generate-api); structuring a PR description with What, Why, How, Testing, and Impact sections; and reviewing PRs by citing AGENTS.md rules and checking dependency direction.
- A developer preparing a feature or bug fix needs to format the PR title following the type(scope): description convention.
- A developer wants to ensure their commit messages follow the project's conventions before pushing.
- A contributor wants to run the required checks before opening a PR to avoid CI failures.
- A developer changed an API contract and needs to regenerate the frontend schema and commit it.
- A reviewer wants to verify that a PR follows the project's architecture rules, such as clean architecture dependency direction.
What are this skill's strengths and limitations?
- Provides clear formatting rules and examples for titles and commits.
- Includes specific make commands for automated checks, reducing manual error.
- Offers a structured PR body template to ensure completeness.
- Encourages adherence to architecture rules and AGENTS.md during review.
- Specific to the SkillHub repository and may not generalize to other projects.
- The make commands are project-specific and may not exist in other setups.
- The skill is purely advisory and does not enforce compliance.
- Missing a formal test suite to validate the skill's own instructions.
How do you install this skill?
The installation method for this skill is not explicitly documented. As part of the SkillHub repository, it resides at .agents/skills/pr-submission/SKILL.md and can be obtained by cloning the iflytek/skillhub repository and copying the skill directory into your agent's skills folder.
How do you use this skill?
When preparing or reviewing a PR, follow these steps: 1. Identify the scope of your change. 2. Format the PR title and commit messages using the conventions. 3. Run the pre-PR checklist commands (e.g., make test-backend-app). 4. Write the PR body following the What/Why/How/Testing/Impact template. Example title: feat(auth): add local account login with password reset.