@relipa/ai-flow-kit 0.0.4-beta.2 → 0.0.4

package/CONTRIBUTING.md

@@ -1,388 +0,0 @@
-# Contributing to AI Flow Kit
-
-Thank you for wanting to improve AI Flow Kit! This guide helps you add custom skills, adapters, templates, and features.
-
-## 🎯 How to Contribute
-
-### 1. Add a Custom Skill
-
-Skills are step-by-step instructions for AI to follow for specific task types.
-
-**Create the skill file:**
-
-```bash
-mkdir -p custom/skills/my-skill
-touch custom/skills/my-skill/SKILL.md
-```
-
-**Write your skill** (`custom/skills/my-skill/SKILL.md`):
-
-```markdown
----
-name: my-skill
-description: Short description of what this skill does
-keywords: keyword1, keyword2
----
-
-# My Skill Name
-
-When to use this skill:
-- Situation 1
-- Situation 2
-
-## Step-by-Step Process
-
-### Step 1: Initial Analysis
-- Do something
-- Check something
-
-### Step 2: Implementation
-- Implement the solution
-- Test results
-
-### Step 3: Validation
-- Verify the fix
-- Document changes
-
-[Add more detailed instructions, examples, and best practices]
-```
-
-**Test your skill:**
-```bash
-aiflow update
-# Your skill will appear in .claude/skills/
-```
-
-### 2. Add a Framework Template
-
-Templates provide framework-specific rules and best practices for CLAUDE.md.
-
-**Create the template:**
-
-```bash
-touch custom/templates/my-framework.md
-```
-
-**Write your template** (`custom/templates/my-framework.md`):
-
-```markdown
-# My Framework System Prompt
-
-You are an expert developer in My Framework. Follow these rules:
-
-## Architecture Rules
-- Rule 1
-- Rule 2
-
-## Code Style
-- Use [specific style]
-- Format with [tool]
-
-## Common Patterns
-- Pattern 1: When to use and examples
-- Pattern 2: When to use and examples
-
-## Testing
-- Write tests with [framework]
-- Use [testing library]
-
-## Performance
-- Avoid [anti-pattern]
-- Use [best practice]
-
-## References
-- [Link to official docs]
-- [Link to team style guide]
-```
-
-**Test your template:**
-```bash
-aiflow init --framework my-framework
-# Should create CLAUDE.md with your content
-```
-
-### 3. Add an MCP Adapter Preset
-
-Presets configure MCP servers (Jira, Backlog, etc.) for easy setup.
-
-**Create the preset:**
-
-```bash
-touch custom/mcp-presets/my-adapter.json
-```
-
-**Write your preset** (`custom/mcp-presets/my-adapter.json`):
-
-```json
-{
-  "mcpServers": {
-    "my-adapter": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@modelcontextprotocol/server-my-adapter"
-      ],
-      "env": {
-        "API_KEY": "{{API_KEY}}",
-        "API_URL": "{{API_URL}}",
-        "TEAM_ID": "{{TEAM_ID}}"
-      }
-    }
-  }
-}
-```
-
-**Test your preset:**
-```bash
-aiflow init --adapter my-adapter
-# Should prompt for environment variables
-# Should update claude_desktop_config.json
-```
-
-### 4. Add a Validation Rule
-
-Rules enforce team standards and code quality.
-
-**Create the rule:**
-
-```bash
-touch custom/rules/my-rule.md
-```
-
-**Write your rule** (`custom/rules/my-rule.md`):
-
-```markdown
-# Rule: My Rule Name
-
-**When:** Applied to [task type]
-**What:** [Description of the rule]
-**Why:** [Reasoning]
-
-## Examples
-
-### ✅ Good
-```code
-[good example]
-```
-
-### ❌ Bad
-```code
-[bad example]
-```
-
-## How to Check
-```bash
-[command to verify]
-```
-```
-
-### 5. Add a Task Type / Prompt Template
-
-Task prompt templates guide developers and AI through specific workflows.
-
-**Create the template:**
-
-```bash
-touch custom/prompts/my-task-type.md
-```
-
-**Write your template** (`custom/prompts/my-task-type.md`):
-
-```markdown
-# My Task Type Prompt Template
-
-## Context (auto-filled from ticket)
-- Title: {{TITLE}}
-- Description: {{DESCRIPTION}}
-- Status: {{STATUS}}
-
-## Your Task
-
-[Clear description of what needs to be done]
-
-## Requirements
-- Requirement 1
-- Requirement 2
-
-## Success Criteria
-- Criteria 1
-- Criteria 2
-
-## Constraints
-- Constraint 1
-- Constraint 2
-
-## Notes
-- Add any context-specific notes
-```
-
-## 📋 Best Practices
-
-### For Skills
-- ✅ Make steps clear and sequential
-- ✅ Include examples for each step
-- ✅ Reference team rules and templates
-- ✅ Suggest how AI should handle errors
-- ❌ Don't assume developer knowledge
-- ❌ Don't make steps too broad or vague
-
-### For Templates
-- ✅ Include specific rules and patterns
-- ✅ Link to official documentation
-- ✅ Show both good and bad examples
-- ✅ Specify code style and formatting
-- ❌ Don't duplicate framework docs
-- ❌ Don't list too many rules (keep < 20)
-
-### For Adapters
-- ✅ Test with real API credentials
-- ✅ Provide clear environment variable names
-- ✅ Document required permissions
-- ✅ Include error handling examples
-- ❌ Don't hardcode credentials
-- ❌ Don't require complex setup steps
-
-### For Rules
-- ✅ Be specific with examples
-- ✅ Explain the reasoning
-- ✅ Show how to verify compliance
-- ✅ Link to relevant docs
-- ❌ Don't make rules too strict
-- ❌ Don't duplicate linters/formatters
-
-## 🔄 Workflow
-
-1. **Create** your contribution in the appropriate folder
-2. **Test** with `aiflow update` and `aiflow doctor`
-3. **Validate** that it works as expected
-4. **Document** with clear names and descriptions
-5. **Share** with your team or submit to project
-
-## 📂 File Organization
-
-```
-custom/
-├── skills/
-│   └── your-skill/
-│       ├── SKILL.md            # Main skill definition
-│       ├── example-1.md        # Optional: detailed example
-│       └── checklist.md        # Optional: verification checklist
-├── templates/
-│   └── your-framework.md       # Framework rules and patterns
-├── rules/
-│   ├── code-style.md
-│   ├── naming.md
-│   └── your-rule.md
-├── prompts/
-│   ├── bug-fix.md
-│   ├── feature.md
-│   └── your-prompt.md
-└── mcp-presets/
-    └── your-adapter.json       # MCP configuration
-```
-
-## 🧪 Testing Your Contributions
-
-### Test Locally
-```bash
-# Update to load your new content
-aiflow update
-
-# Check it loaded correctly
-aiflow doctor
-
-# Verify the file exists
-ls .claude/skills/your-skill/SKILL.md
-ls custom/rules/your-rule.md
-```
-
-### Test with AI
-1. Use `aiflow prompt` to generate a template with your rule
-2. Try using your skill in Claude Code
-3. Verify AI follows your guidelines
-
-### Validate Output
-```bash
-# Check if output violates any rules
-aiflow validate <output-file>
-
-# Run tests if applicable
-npm test
-```
-
-## 🚀 Submitting Your Contribution
-
-### For Team Use
-1. Create branch: `git checkout -b feature/add-my-skill`
-2. Add your files to `custom/`
-3. Create Pull Request with description
-4. Team reviews and merges
-5. Run `aiflow update` to distribute
-
-### For Community
-1. Fork the repository
-2. Create feature branch
-3. Add your contribution to `custom/`
-4. Include documentation
-5. Submit Pull Request
-
-## ❓ FAQ
-
-**Q: Where should I put my custom code?**
-A: Everything goes in `custom/` folder. It's separate from `upstream/` (original obra/superpowers), making updates easier.
-
-**Q: How do I test my skill before sharing?**
-A: Run `aiflow update`, then use it in Claude Code. AI should follow your instructions.
-
-**Q: Can I modify upstream skills?**
-A: No, keep `upstream/` read-only. Copy to `custom/` and modify there.
-
-**Q: How do I make sure my contribution is good quality?**
-A: See Best Practices section above. Also ask team members to try it.
-
-## 📞 Getting Help
-
-- 📖 Read [Architecture Guide](./docs/architecture.md)
-- 💬 Ask in [Discussions](./discussions)
-- 🔍 Look at existing examples in `custom/`
-
-## 📦 Release Management
-
-We use NPM tags to manage beta and stable releases.
-
-### 1. Beta Releases (Testing)
-
-For new features or bug fixes that need testing before official release:
-
-1. **Bump version** to a beta tag:
-   ```bash
-   # First beta
-   npm version 0.0.3-beta.0
-   # Subsequent betas
-   npm version prerelease
-   ```
-2. **Publish** to the `beta` tag:
-   ```bash
-   npm run publish:beta
-   ```
-3. **Test** the beta version:
-   ```bash
-   npm install -g @relipa/ai-flow-kit@beta
-   ```
-
-### 2. Stable Releases (Official)
-
-Once the beta is verified:
-
-1. **Bump version** to the stable version:
-   ```bash
-   npm version 0.0.3
-   ```
-2. **Publish** to the `latest` tag:
-   ```bash
-   npm run publish:stable
-   ```
-
----
-
-**Help us build better AI development workflows!** 🚀