Hack23

contribution-guidelines

该技能说明CIA项目的贡献流程,包括分支、拉取请求、Conventional Commits和代码审查。适用于提交代码、审查变更或报告问题时遵循项目规范。

Hack23 242 56 更新于 8个月前
GitHub

安装

npx skillscat add hack23/cia/contribution-guidelines

通过 SkillsCat registry 安装。

技能简介

该技能说明CIA项目的贡献流程,包括分支、拉取请求、Conventional Commits和代码审查。适用于提交代码、审查变更或报告问题时遵循项目规范。

SKILL.md

Contribution Guidelines Skill

Purpose

Follow proper contribution process for CIA project including PR workflow and code review standards.

When to Use

  • ✅ Submitting pull requests
  • ✅ Conducting code reviews
  • ✅ Contributing to open source
  • ✅ Reporting bugs or requesting features

Pull Request Process

1. Fork and Clone

git clone https://github.com/YOUR-USERNAME/cia.git
cd cia
git remote add upstream https://github.com/Hack23/cia.git

2. Create Feature Branch

git checkout -b feature/politician-analytics

3. Make Changes

# Follow coding standards
# Write tests
# Update documentation

4. Commit with Conventional Commits

git commit -m "feat: add politician voting analytics dashboard"
git commit -m "fix: resolve SQL injection in search endpoint"
git commit -m "docs: update SECURITY_ARCHITECTURE.md"

5. Push and Create PR

git push origin feature/politician-analytics
# Create PR via GitHub UI

Code Review Checklist

For Contributors

  • ✅ All tests pass locally
  • ✅ Code follows project conventions
  • ✅ Documentation updated
  • ✅ Security considerations addressed
  • ✅ No secrets committed

For Reviewers

  • ✅ Code is maintainable and readable
  • ✅ Test coverage adequate
  • ✅ Security vulnerabilities checked
  • ✅ Performance implications considered
  • ✅ Documentation complete

Commit Message Format

type(scope): subject

body

footer

Types: feat, fix, docs, style, refactor, test, chore

References

  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • PULL_REQUEST_TEMPLATE.md