From c0be92b833f259ed40faf8af09d21d49186fbbb5 Mon Sep 17 00:00:00 2001 From: kevin rajan Date: Tue, 21 Oct 2025 18:07:44 -0500 Subject: [PATCH 01/16] docs: add core community health files and setup plan Add foundational open source community health files following best practices: - README.md: Comprehensive project overview with features, quick start guide, usage examples for SPARC/agents/PM system, and architecture documentation - CONTRIBUTING.md: Developer guidelines with SPARC methodology, shell script style guide, testing requirements, PR process, and agent coordination - CODE_OF_CONDUCT.md: Contributor Covenant 2.1 community standards - SECURITY.md: Vulnerability reporting process, security policy, and best practices for contributors and users - docs/github-setup-plan.md: Complete implementation roadmap for repository improvements across 4 phases - TODO.md: Task tracking for CCPM integration (pending installation) Phase 1 (Core Community Health Files) complete. Enables community participation and establishes professional project standards. Note: Placeholders need updating (contact emails, repository URLs) --- CODE_OF_CONDUCT.md | 133 +++++++++++++ CONTRIBUTING.md | 400 ++++++++++++++++++++++++++++++++++++++ README.md | 209 ++++++++++++++++++++ SECURITY.md | 169 ++++++++++++++++ TODO.md | 220 +++++++++++++++++++++ docs/github-setup-plan.md | 179 +++++++++++++++++ 6 files changed, 1310 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md create mode 100644 SECURITY.md create mode 100644 TODO.md create mode 100644 docs/github-setup-plan.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3a84de0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT EMAIL]. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..caa0940 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,400 @@ +# Contributing to Claude Code Extended Framework + +Thank you for your interest in contributing! This document provides guidelines for contributing to this project. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [Development Workflow](#development-workflow) +- [SPARC Methodology](#sparc-methodology) +- [Code Style Guidelines](#code-style-guidelines) +- [File Organization](#file-organization) +- [Testing Requirements](#testing-requirements) +- [Pull Request Process](#pull-request-process) +- [Agent Coordination](#agent-coordination) +- [Adding New Features](#adding-new-features) + +## Code of Conduct + +This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers. + +## Getting Started + +### Prerequisites + +- [Claude Code CLI](https://docs.claude.com/claude-code) installed +- Git configured with your name and email +- Bash shell environment (Linux, macOS, or WSL on Windows) +- Basic understanding of shell scripting + +### Development Setup + +1. **Fork and clone the repository:** +```bash +git fork https://github.com/YOUR_USERNAME/YOUR_REPO.git +git clone https://github.com/YOUR_USERNAME/YOUR_REPO.git +cd YOUR_REPO +``` + +2. **Create a feature branch:** +```bash +git checkout -b feature/your-feature-name +``` + +3. **Set up MCP servers (recommended):** +```bash +claude mcp add claude-flow npx claude-flow@alpha mcp start +claude mcp add ruv-swarm npx ruv-swarm mcp start # Optional +``` + +4. **Review the project structure:** +```bash +cat CLAUDE.md # Main configuration +ls -la .claude/ # Configuration directory +cat docs/github-setup-plan.md # Development roadmap +``` + +## Development Workflow + +### SPARC Methodology + +This project follows the SPARC methodology for systematic development: + +1. **Specification**: Define requirements clearly + - Write PRD if adding major feature + - Create GitHub issue with detailed description + - Identify success criteria + +2. **Pseudocode**: Design before implementation + - Outline algorithm/logic in comments + - Plan function signatures and data structures + - Review with maintainers if complex + +3. **Architecture**: Document system design + - Update architecture diagrams if needed + - Document integration points + - Explain design decisions + +4. **Refinement**: Test-Driven Development + - Write tests BEFORE implementation + - Ensure tests fail initially + - Implement until tests pass + - Refactor while keeping tests green + +5. **Completion**: Validate integration + - Run full test suite + - Update documentation + - Verify no regressions + +### Feature Branch Workflow + +```bash +# Always work on feature branches, never on main +git checkout -b feature/descriptive-name + +# Make incremental commits +git add . +git commit -m "feat: add user authentication helper" + +# Keep branch updated with main +git fetch origin +git rebase origin/main + +# Push when ready +git push origin feature/descriptive-name +``` + +## Code Style Guidelines + +### Shell Scripts + +**Follow these conventions for all `.sh` files:** + +```bash +#!/usr/bin/env bash +set -euo pipefail # Exit on error, undefined vars, pipe failures + +# Use descriptive variable names +readonly PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +readonly CONFIG_DIR="${PROJECT_ROOT}/.claude" + +# Add comments for complex logic +# Validates that the repository is not the CCPM template +validate_repository() { + local remote_url + remote_url=$(git remote get-url origin 2>/dev/null || echo "") + + if [[ "$remote_url" == *"automazeio/ccpm"* ]]; then + echo "❌ ERROR: Cannot sync with template repository" >&2 + return 1 + fi +} + +# Use functions for reusability +main() { + validate_repository || exit 1 + # Implementation... +} + +main "$@" +``` + +**Style Requirements:** +- Use `#!/usr/bin/env bash` shebang +- Set strict mode: `set -euo pipefail` +- Use `readonly` for constants +- Quote all variables: `"${variable}"` +- Use `local` for function variables +- Add descriptive comments +- Use meaningful function names +- Return early on errors +- Use `>&2` for error messages + +### Configuration Files + +**For `.md` files in `.claude/commands/`:** +```markdown +--- +name: command-name +description: Brief description of what this command does +category: category-name +--- + +# Command Implementation + +Detailed documentation and implementation... +``` + +**For rule files in `.claude/rules/`:** +```markdown +# Rule Title + +Clear, actionable rules with examples. + +## Section + +✅ Correct examples +❌ Incorrect examples +``` + +## File Organization + +**Critical Rule: NEVER save working files to the root folder** + +Use these directories: + +``` +.claude/ +├── commands/ # Slash command definitions +├── rules/ # Coordination and operation rules +├── helpers/ # Reusable shell scripts +├── prds/ # Product requirement documents +├── context/ # Project context files +└── statusline/ # Status line configuration + +docs/ # Documentation and analysis +scripts/ # Utility scripts +.github/ # GitHub workflows and templates +``` + +### Path Standards + +Follow `.claude/rules/path-standards.md`: +- Use relative paths for project files: `internal/auth/server.go` +- No absolute paths with usernames: ❌ `/Users/username/project/...` +- Cross-project references: `../project-name/file.go` + +## Testing Requirements + +### Shell Script Testing + +```bash +# Run shellcheck on all scripts +shellcheck scripts/*.sh .claude/helpers/*.sh + +# Test scripts in isolated environment +bash -n script.sh # Syntax check +bash -x script.sh # Debug mode +``` + +### Integration Testing + +Before submitting PR: +```bash +# Test slash command execution +# (requires Claude Code CLI) + +# Test helper scripts +./scripts/checkpoint.sh +./scripts/migrate-agents.sh --dry-run + +# Verify GitHub workflows syntax +# (use GitHub Actions workflow validator) +``` + +## Pull Request Process + +### Before Submitting + +- [ ] Follow SPARC methodology (all 5 phases) +- [ ] Tests written and passing +- [ ] Shell scripts pass `shellcheck` +- [ ] Documentation updated +- [ ] Commit messages follow convention (see below) +- [ ] No hardcoded paths or secrets +- [ ] Files organized in correct directories + +### Commit Message Convention + +``` +(): + + + +