SuperAPI AI Directory

contribution-guidelines

Coding & development

View repository

Updated 10-16 06:57

About this skill

Contribution Guidelines Skill

Purpose

Follow proper open source contribution process including PR workflow, code review standards, and commit conventions.

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/European-Parliament-MCP-Server.git
cd European-Parliament-MCP-Server
git remote add upstream https://github.com/Hack23/European-Parliament-MCP-Server.git

2. Create Feature Branch

git checkout -b feature/new-mcp-tool

3. Make Changes

npm ci                  # Install dependencies
npm run lint            # Check code style
npm test                # Run tests
npm run build           # Verify build

4. Commit with Conventional Commits

git commit -m "feat: add search_votes MCP tool"
git commit -m "fix: handle API timeout in MEP lookup"
git commit -m "docs: update SECURITY_ARCHITECTURE.md"
git commit -m "test: add integration tests for committee API"

5. Submit PR

git push origin feature/new-mcp-tool
# Create PR via GitHub UI

Code Review Checklist

For Contributors

  • ✅ All tests pass (npm test)
  • ✅ Lint passes (npm run lint)
  • ✅ TypeScript type check passes (npx tsc --noEmit)
  • ✅ Code follows project conventions
  • ✅ Documentation updated
  • ✅ No secrets committed
  • ✅ Test coverage maintained (80%+)

For Reviewers

  • ✅ Code is maintainable and well-typed
  • ✅ Input validation with Zod schemas
  • ✅ Error handling follows patterns
  • ✅ Security implications considered
  • ✅ ISMS policy compliance verified
  • ✅ Performance impact acceptable

Commit Types

Type Description
feat New functionality
fix Bug fix
docs Documentation only
style Code style (formatting)
refactor Code restructuring
test Adding/updating tests
chore Maintenance tasks
security Security fix

ISMS Policy References

Core policies:

Supporting policies (cite when applicable):