@shellicar OSS Conventions
Git and PR conventions for published npm packages under the @shellicar scope.
Detection
Match when:
- Remote URL contains
github.com/shellicar/ - Working directory under
$HOME/repos/@shellicar/
Platform
- Platform: GitHub
- CLI:
gh
Branch Naming
feature/<name>fix/<name>main(default branch)
Commit Messages
- Concise, single line
- Imperative mood
- No prefix conventions required
PR Workflow
1. Check for Milestone
Before creating a PR, ensure a milestone exists for the next version:
gh api repos/{owner}/{repo}/milestones --jq '.[].title'
If no milestone exists for the next version, create one:
gh api repos/{owner}/{repo}/milestones --method POST -f title="1.2.0"
Version format: Use x.y.z (no v prefix).
2. Link PR to Milestone
When creating/updating the PR, attach the milestone:
gh pr create --title "Title" --body "Description" --milestone "1.2.0"
gh pr edit --add-milestone "1.2.0"
3. Reference Issues
Link related issues in the PR description using GitHub keywords:
Fixes #123- closes the issue when PR mergesCloses #123- same as FixesResolves #123- same as FixesRefs #123- references without closing
PR Description Format
## Summary
Brief description of the changes.
## Related Issues
Fixes #123
Closes #456
## Changes
- Change 1
- Change 2
Co-Authorship
Include Co-Authored-By: Claude <noreply@anthropic.com> in the PR description (not in commits) if you would like to be credited.
Issue and Milestone Linking
- Issues: Reference with
Fixes #123,Closes #123, orRefs #123 - Milestones: Every PR must be linked to a version milestone
CLI Commands
# Milestones
gh api repos/{owner}/{repo}/milestones --jq '.[].title'
gh api repos/{owner}/{repo}/milestones --method POST -f title="1.2.0"
# Create PR with milestone
gh pr create --title "Title" --body "Description" --milestone "1.2.0"
# Update PR
gh pr edit --title "New title" --body "New description"
gh pr edit --add-milestone "1.2.0"
# List PRs
gh pr list
# View PR
gh pr view 123
# List issues
gh issue list
gh issue view 123
Package-Specific Considerations
- Ensure version bumps follow semver
- Update CHANGELOG.md if present
- Consider npm publish implications
Repository Configuration
Use the github-repos skill to apply these settings.
Desired Settings
- Wiki: disabled
- Projects: disabled
- Discussions: disabled
- Issues: enabled
- Auto-merge: enabled
- Delete branch on merge: enabled
- Default branch: main
Desired Ruleset (name: main)
Target: default branch. Rules:
deletionnon_fast_forwardcode_scanning(CodeQL, high_or_higher)pull_request(0 approvals, squash only)creationrequired_status_checks(omit if no CI)
