aia 2.0.0.0.pre.alpha → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.version +1 -1
- data/CHANGELOG.md +151 -228
- data/README.md +42 -19
- data/bin/aia +8 -3
- data/lib/aia/aia_completion.bash +2 -3
- data/lib/aia/aia_completion.fish +6 -5
- data/lib/aia/aia_completion.zsh +2 -3
- data/lib/aia/chat_loop.rb +24 -66
- data/lib/aia/config/cli_parser.rb +164 -123
- data/lib/aia/config/defaults.yml +12 -39
- data/lib/aia/config/mcp_parser.rb +42 -40
- data/lib/aia/config/model_spec.rb +8 -14
- data/lib/aia/config/validator.rb +144 -156
- data/lib/aia/config/value_caster.rb +76 -0
- data/lib/aia/config.rb +72 -54
- data/lib/aia/content_extractor.rb +2 -0
- data/lib/aia/cost_calculator.rb +1 -0
- data/lib/aia/crew.rb +29 -19
- data/lib/aia/debate_handler.rb +45 -20
- data/lib/aia/delegate_handler.rb +7 -3
- data/lib/aia/directive.rb +10 -8
- data/lib/aia/directives/configuration_directives.rb +164 -109
- data/lib/aia/directives/context_directives.rb +55 -40
- data/lib/aia/directives/execution_directives.rb +25 -25
- data/lib/aia/directives/model_directives.rb +112 -195
- data/lib/aia/directives/trakflow_directives.rb +27 -9
- data/lib/aia/directives/utility_directives.rb +86 -87
- data/lib/aia/directives/web_and_file_directives.rb +83 -63
- data/lib/aia/fact_asserter.rb +3 -3
- data/lib/aia/history_transfer.rb +64 -24
- data/lib/aia/layered_orchestrator.rb +66 -43
- data/lib/aia/logger.rb +27 -62
- data/lib/aia/mcp_config_normalizer.rb +27 -14
- data/lib/aia/mcp_connection_manager.rb +193 -186
- data/lib/aia/mcp_discovery.rb +43 -15
- data/lib/aia/mcp_grouper.rb +2 -1
- data/lib/aia/mcp_server_config.rb +48 -0
- data/lib/aia/mcp_utility.rb +28 -20
- data/lib/aia/mention_router.rb +22 -52
- data/lib/aia/modality_query.rb +36 -0
- data/lib/aia/model_alias_registry.rb +11 -11
- data/lib/aia/model_registry.rb +75 -0
- data/lib/aia/network_builder.rb +17 -11
- data/lib/aia/network_memory_manager.rb +6 -6
- data/lib/aia/patches/ruby_llm_streaming_error.rb +21 -4
- data/lib/aia/patches/ruby_llm_tool_param_compat.rb +18 -0
- data/lib/aia/pipeline_orchestrator.rb +88 -45
- data/lib/aia/plugin_monitor.rb +9 -6
- data/lib/aia/prompt_decomposer.rb +6 -4
- data/lib/aia/prompt_handler.rb +90 -69
- data/lib/aia/provider_registry.rb +105 -0
- data/lib/aia/robot_builder.rb +1 -1
- data/lib/aia/robot_factory.rb +77 -69
- data/lib/aia/robot_namer.rb +2 -8
- data/lib/aia/robot_sync.rb +79 -0
- data/lib/aia/role_catalog.rb +89 -0
- data/lib/aia/session.rb +32 -14
- data/lib/aia/session_tracker.rb +39 -41
- data/lib/aia/similarity_scorer.rb +5 -3
- data/lib/aia/skill_utils.rb +60 -19
- data/lib/aia/spawn_handler.rb +16 -4
- data/lib/aia/spawn_spec_parser.rb +6 -7
- data/lib/aia/special_mode_handler.rb +80 -57
- data/lib/aia/speech.rb +103 -0
- data/lib/aia/startup_coordinator.rb +17 -91
- data/lib/aia/streaming_runner.rb +16 -5
- data/lib/aia/system_prompt_assembler.rb +20 -15
- data/lib/aia/task_board.rb +60 -0
- data/lib/aia/task_coordinator.rb +10 -5
- data/lib/aia/timing.rb +15 -0
- data/lib/aia/tool_approver.rb +205 -0
- data/lib/aia/tool_filter.rb +1 -9
- data/lib/aia/tool_filter_strategy.rb +39 -25
- data/lib/aia/tool_introspection.rb +25 -0
- data/lib/aia/tool_loader.rb +71 -31
- data/lib/aia/tool_utility.rb +6 -5
- data/lib/aia/tools/delegate_to_foreman_tool.rb +6 -4
- data/lib/aia/tools/recruit_robot_tool.rb +12 -12
- data/lib/aia/tools/reskill_robot_tool.rb +7 -7
- data/lib/aia/tools/task_board_tool.rb +17 -16
- data/lib/aia/trakflow_bridge.rb +19 -11
- data/lib/aia/turn_state.rb +32 -8
- data/lib/aia/ui_presenter.rb +83 -59
- data/lib/aia/utility.rb +8 -24
- data/lib/aia/variable_input_collector.rb +1 -3
- data/lib/aia/verification_network.rb +10 -12
- data/lib/aia.rb +49 -8
- metadata +27 -162
- data/.better-commits.json +0 -150
- data/.config/tocer/configuration.yml +0 -6
- data/.envrc +0 -15
- data/.loki +0 -231
- data/.quality/flay_baseline.txt +0 -1
- data/.quality/flog_baseline.txt +0 -29
- data/.quality/reek_baseline.txt +0 -80
- data/.rubocop.yml +0 -116
- data/COMMITS.md +0 -196
- data/IMPLEMENTATION_PLAN.md +0 -506
- data/Rakefile +0 -160
- data/architecture_review.md +0 -314
- data/docs/AGENTS.md +0 -40
- data/docs/advanced-prompting.md +0 -814
- data/docs/assets/images/aia.png +0 -0
- data/docs/cli-reference.md +0 -1241
- data/docs/configuration.md +0 -747
- data/docs/contributing.md +0 -386
- data/docs/directives-reference.md +0 -1145
- data/docs/examples/index.md +0 -277
- data/docs/examples/mcp/index.md +0 -475
- data/docs/examples/prompts/analysis/index.md +0 -78
- data/docs/examples/prompts/automation/index.md +0 -109
- data/docs/examples/prompts/development/index.md +0 -125
- data/docs/examples/prompts/index.md +0 -333
- data/docs/examples/prompts/learning/index.md +0 -127
- data/docs/examples/prompts/writing/index.md +0 -62
- data/docs/examples/tools/index.md +0 -282
- data/docs/faq.md +0 -578
- data/docs/guides/available-models.md +0 -366
- data/docs/guides/basic-usage.md +0 -478
- data/docs/guides/chat.md +0 -680
- data/docs/guides/crew.md +0 -239
- data/docs/guides/executable-prompts.md +0 -331
- data/docs/guides/first-prompt.md +0 -454
- data/docs/guides/getting-started.md +0 -455
- data/docs/guides/image-generation.md +0 -507
- data/docs/guides/index.md +0 -48
- data/docs/guides/local-models.md +0 -306
- data/docs/guides/migrate-prompts.md +0 -335
- data/docs/guides/models.md +0 -1017
- data/docs/guides/shared-tools.md +0 -254
- data/docs/guides/tools.md +0 -831
- data/docs/index.md +0 -259
- data/docs/installation.md +0 -274
- data/docs/mcp-integration.md +0 -603
- data/docs/prompt_management.md +0 -665
- data/docs/security.md +0 -674
- data/docs/special_projects_guide.md +0 -386
- data/docs/tools-and-mcp-examples.md +0 -1211
- data/docs/workflows-and-pipelines.md +0 -636
- data/examples/.gitignore +0 -2
- data/examples/00_setup_aia.sh +0 -111
- data/examples/01_basic_usage.sh +0 -23
- data/examples/02_frontmatter.sh +0 -33
- data/examples/03_shell_integration.sh +0 -55
- data/examples/04_erb_templating.sh +0 -56
- data/examples/05_shell_then_erb.sh +0 -38
- data/examples/06_prompt_chaining.sh +0 -59
- data/examples/07_pipeline.sh +0 -46
- data/examples/08_context_files.sh +0 -43
- data/examples/09_roles.sh +0 -67
- data/examples/10_stdin_piping.sh +0 -49
- data/examples/11_multi_model.sh +0 -65
- data/examples/12_token_usage.sh +0 -52
- data/examples/13_cost_tracking.sh +0 -68
- data/examples/14_output_file.sh +0 -91
- data/examples/15_parameters.sh +0 -68
- data/examples/16_directives.sh +0 -113
- data/examples/17_require_and_conditionals.sh +0 -68
- data/examples/18_tools.sh +0 -61
- data/examples/19_local_tools.sh +0 -34
- data/examples/20_mcp_servers.sh +0 -102
- data/examples/21_executable_prompts.sh +0 -78
- data/examples/22_chat_mode.sh +0 -217
- data/examples/23_verify.sh +0 -139
- data/examples/24_decompose.sh +0 -139
- data/examples/25_spawn.sh +0 -139
- data/examples/26_debate.sh +0 -97
- data/examples/27_mention_routing.sh +0 -157
- data/examples/28_model_switching.sh +0 -106
- data/examples/29_agent_harness.sh +0 -177
- data/examples/README.md +0 -321
- data/examples/advanced_multi_robot_capabilities_without_examples.md +0 -106
- data/examples/aia_config.yml +0 -22
- data/examples/aia_config_orchestrator.yml +0 -45
- data/examples/aia_config_with_mcp.yml +0 -21
- data/examples/common.sh +0 -39
- data/examples/context/project_goals.md +0 -6
- data/examples/context/tech_stack.md +0 -7
- data/examples/directives/timestamp_directive.rb +0 -22
- data/examples/mcp/filesystem.json +0 -9
- data/examples/prompts_dir/analyze.md +0 -2
- data/examples/prompts_dir/brainstorm.md +0 -2
- data/examples/prompts_dir/conditional.md +0 -17
- data/examples/prompts_dir/creative.md +0 -4
- data/examples/prompts_dir/erbinfo.md +0 -5
- data/examples/prompts_dir/erbinfo_raw.md +0 -8
- data/examples/prompts_dir/evaluate.md +0 -2
- data/examples/prompts_dir/explain_joke.md +0 -1
- data/examples/prompts_dir/explain_recursion.md +0 -1
- data/examples/prompts_dir/fun_fact +0 -3
- data/examples/prompts_dir/greeting.md +0 -8
- data/examples/prompts_dir/greeting_required.md +0 -7
- data/examples/prompts_dir/hello.md +0 -1
- data/examples/prompts_dir/includes/ruby_facts.md +0 -4
- data/examples/prompts_dir/limerick.md +0 -1
- data/examples/prompts_dir/list_with_mcp.md +0 -3
- data/examples/prompts_dir/pick_best.md +0 -2
- data/examples/prompts_dir/project_summary +0 -12
- data/examples/prompts_dir/quiz_with_include.md +0 -6
- data/examples/prompts_dir/require_demo.md +0 -5
- data/examples/prompts_dir/roles/formal.md +0 -3
- data/examples/prompts_dir/roles/orchestrator.md +0 -21
- data/examples/prompts_dir/roles/pirate.md +0 -3
- data/examples/prompts_dir/shell_then_erb.md +0 -6
- data/examples/prompts_dir/sort_compare.md +0 -2
- data/examples/prompts_dir/summarize_context.md +0 -2
- data/examples/prompts_dir/sysinfo.md +0 -5
- data/examples/prompts_dir/sysinfo_raw.md +0 -8
- data/examples/prompts_dir/tagline.md +0 -1
- data/examples/prompts_dir/tell_joke.md +0 -1
- data/examples/prompts_dir/tell_joke_with_next.md +0 -4
- data/examples/prompts_dir/use_local_tool.md +0 -8
- data/examples/prompts_dir/use_tools.md +0 -8
- data/examples/prompts_dir/weather.md +0 -2
- data/examples/prompts_dir/whats_new.md +0 -2
- data/examples/prompts_dir/with_timestamp.md +0 -5
- data/examples/requirements/sinatra_taskflow_app.md +0 -139
- data/examples/rules/01_classify_ruby.rb +0 -16
- data/examples/rules/02_prefer_claude_for_code.rb +0 -19
- data/examples/rules/03_gate_prompt_length.rb +0 -19
- data/examples/rules/04_tool_selection.rb +0 -41
- data/examples/rules/README.md +0 -30
- data/examples/run_all.sh +0 -294
- data/examples/tools/word_count_tool.rb +0 -30
- data/lib/AGENTS.md +0 -57
- data/lib/aia/model_switch_handler.rb +0 -100
- data/mcp_servers/README.md +0 -110
- data/mcp_servers/apple-mcp.json +0 -8
- data/mcp_servers/filesystem.json +0 -9
- data/mcp_servers/mcp_server_chart.json +0 -11
- data/mcp_servers/playwright_one.json +0 -8
- data/mcp_servers/playwright_server_definition.json +0 -9
- data/mcp_servers/playwright_two.json +0 -8
- data/mcp_servers/tavily_mcp_server.json +0 -8
- data/mkdocs.yml +0 -169
data/docs/contributing.md
DELETED
|
@@ -1,386 +0,0 @@
|
|
|
1
|
-
<!-- Tocer[start]: Auto-generated, don't remove. -->
|
|
2
|
-
|
|
3
|
-
## Table of Contents
|
|
4
|
-
|
|
5
|
-
- [Contributing to AIA](#contributing-to-aia)
|
|
6
|
-
- [Ways to Contribute](#ways-to-contribute)
|
|
7
|
-
- [1. Report Issues](#1-report-issues)
|
|
8
|
-
- [2. Submit Code Changes](#2-submit-code-changes)
|
|
9
|
-
- [3. Improve Documentation](#3-improve-documentation)
|
|
10
|
-
- [4. Contribute Examples](#4-contribute-examples)
|
|
11
|
-
- [Getting Started](#getting-started)
|
|
12
|
-
- [Prerequisites](#prerequisites)
|
|
13
|
-
- [Setting Up Development Environment](#setting-up-development-environment)
|
|
14
|
-
- [Development Guidelines](#development-guidelines)
|
|
15
|
-
- [Code Standards](#code-standards)
|
|
16
|
-
- [Ruby Style Guide](#ruby-style-guide)
|
|
17
|
-
- [Testing Requirements](#testing-requirements)
|
|
18
|
-
- [Documentation Standards](#documentation-standards)
|
|
19
|
-
- [Commit Message Format](#commit-message-format)
|
|
20
|
-
- [Contributing Examples](#contributing-examples)
|
|
21
|
-
- [Prompt Examples](#prompt-examples)
|
|
22
|
-
- [File Structure](#file-structure)
|
|
23
|
-
- [Prompt Template Format](#prompt-template-format)
|
|
24
|
-
- [Tool Examples](#tool-examples)
|
|
25
|
-
- [File Structure](#file-structure-1)
|
|
26
|
-
- [Tool Template](#tool-template)
|
|
27
|
-
- [MCP Client Examples](#mcp-client-examples)
|
|
28
|
-
- [File Structure](#file-structure-2)
|
|
29
|
-
- [Pull Request Process](#pull-request-process)
|
|
30
|
-
- [Before Submitting](#before-submitting)
|
|
31
|
-
- [Submitting the Pull Request](#submitting-the-pull-request)
|
|
32
|
-
- [Review Process](#review-process)
|
|
33
|
-
- [Community Guidelines](#community-guidelines)
|
|
34
|
-
- [Communication](#communication)
|
|
35
|
-
- [Issue Reporting](#issue-reporting)
|
|
36
|
-
- [Feature Requests](#feature-requests)
|
|
37
|
-
- [Security](#security)
|
|
38
|
-
- [Reporting Security Issues](#reporting-security-issues)
|
|
39
|
-
- [Security Best Practices](#security-best-practices)
|
|
40
|
-
- [Recognition](#recognition)
|
|
41
|
-
- [Contributors](#contributors)
|
|
42
|
-
- [Types of Recognition](#types-of-recognition)
|
|
43
|
-
- [Getting Help](#getting-help)
|
|
44
|
-
- [Development Questions](#development-questions)
|
|
45
|
-
- [Code Review](#code-review)
|
|
46
|
-
- [Community Support](#community-support)
|
|
47
|
-
- [Release Process](#release-process)
|
|
48
|
-
- [Version Management](#version-management)
|
|
49
|
-
- [Release Schedule](#release-schedule)
|
|
50
|
-
- [Thank You!](#thank-you)
|
|
51
|
-
|
|
52
|
-
<!-- Tocer[finish]: Auto-generated, don't remove. -->
|
|
53
|
-
|
|
54
|
-
# Contributing to AIA
|
|
55
|
-
|
|
56
|
-
We welcome contributions to AIA! This guide will help you get started with contributing to the project.
|
|
57
|
-
|
|
58
|
-
## Ways to Contribute
|
|
59
|
-
|
|
60
|
-
### 1. Report Issues
|
|
61
|
-
- **Bug Reports**: Found a bug? Please report it with detailed steps to reproduce
|
|
62
|
-
- **Feature Requests**: Have an idea for a new feature? We'd love to hear about it
|
|
63
|
-
- **Documentation Issues**: Spot errors or areas for improvement in documentation
|
|
64
|
-
|
|
65
|
-
### 2. Submit Code Changes
|
|
66
|
-
- **Bug Fixes**: Help fix reported issues
|
|
67
|
-
- **New Features**: Implement requested features or propose new ones
|
|
68
|
-
- **Performance Improvements**: Optimize existing code
|
|
69
|
-
- **Tests**: Improve test coverage and quality
|
|
70
|
-
|
|
71
|
-
### 3. Improve Documentation
|
|
72
|
-
- **User Guides**: Help improve user-facing documentation
|
|
73
|
-
- **Code Comments**: Add or improve inline documentation
|
|
74
|
-
- **Examples**: Contribute new examples or improve existing ones
|
|
75
|
-
- **Tutorials**: Create learning materials for new users
|
|
76
|
-
|
|
77
|
-
### 4. Contribute Examples
|
|
78
|
-
- **Prompts**: Share useful prompt templates
|
|
79
|
-
- **Tools**: Create Ruby tools that extend AIA's capabilities
|
|
80
|
-
- **MCP Clients**: Develop Model Context Protocol integrations
|
|
81
|
-
|
|
82
|
-
## Getting Started
|
|
83
|
-
|
|
84
|
-
### Prerequisites
|
|
85
|
-
- Ruby >= 4.0.0 installed
|
|
86
|
-
- Git for version control
|
|
87
|
-
- Familiarity with AI/LLM concepts
|
|
88
|
-
- Understanding of command-line tools
|
|
89
|
-
|
|
90
|
-
### Setting Up Development Environment
|
|
91
|
-
|
|
92
|
-
1. **Fork and Clone**
|
|
93
|
-
```bash
|
|
94
|
-
git clone https://github.com/your-username/aia.git
|
|
95
|
-
cd aia
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
2. **Install Dependencies**
|
|
99
|
-
```bash
|
|
100
|
-
bundle install
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
3. **Run Tests**
|
|
104
|
-
```bash
|
|
105
|
-
rake test
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
4. **Create Feature Branch**
|
|
109
|
-
```bash
|
|
110
|
-
git checkout -b feature/your-feature-name
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
## Development Guidelines
|
|
114
|
-
|
|
115
|
-
### Code Standards
|
|
116
|
-
|
|
117
|
-
#### Ruby Style Guide
|
|
118
|
-
- Follow Ruby community conventions
|
|
119
|
-
- Use descriptive variable and method names
|
|
120
|
-
- Write clear, concise comments
|
|
121
|
-
- Maintain consistent indentation (2 spaces)
|
|
122
|
-
- Keep line length under 120 characters
|
|
123
|
-
|
|
124
|
-
#### Testing Requirements
|
|
125
|
-
- Write tests for all new functionality
|
|
126
|
-
- Maintain or improve test coverage
|
|
127
|
-
- Use descriptive test names
|
|
128
|
-
- Include both unit and integration tests
|
|
129
|
-
|
|
130
|
-
#### Documentation Standards
|
|
131
|
-
- Update README if needed
|
|
132
|
-
- Add inline documentation for public methods
|
|
133
|
-
- Include usage examples
|
|
134
|
-
- Update CHANGELOG.md for user-facing changes
|
|
135
|
-
|
|
136
|
-
### Commit Message Format
|
|
137
|
-
|
|
138
|
-
Use clear, descriptive commit messages following this format:
|
|
139
|
-
|
|
140
|
-
```
|
|
141
|
-
type(scope): brief description
|
|
142
|
-
|
|
143
|
-
Longer description if needed
|
|
144
|
-
|
|
145
|
-
- List key changes
|
|
146
|
-
- Include breaking changes
|
|
147
|
-
- Reference issues: Fixes #123
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
**Types:**
|
|
151
|
-
- `feat`: New feature
|
|
152
|
-
- `fix`: Bug fix
|
|
153
|
-
- `docs`: Documentation changes
|
|
154
|
-
- `test`: Test-related changes
|
|
155
|
-
- `refactor`: Code refactoring
|
|
156
|
-
- `perf`: Performance improvements
|
|
157
|
-
|
|
158
|
-
**Examples:**
|
|
159
|
-
```
|
|
160
|
-
feat(cli): add --fuzzy flag for prompt selection
|
|
161
|
-
|
|
162
|
-
fix(config): resolve issue with nested YAML parsing
|
|
163
|
-
|
|
164
|
-
docs(examples): add MCP client integration examples
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
## Contributing Examples
|
|
168
|
-
|
|
169
|
-
### Prompt Examples
|
|
170
|
-
|
|
171
|
-
#### File Structure
|
|
172
|
-
```
|
|
173
|
-
docs/examples/prompts/category/
|
|
174
|
-
├── index.md # Category overview
|
|
175
|
-
├── example_name.md # Prompt file
|
|
176
|
-
└── example_name_usage.md # Usage documentation
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
#### Prompt Template Format
|
|
180
|
-
```markdown
|
|
181
|
-
# Prompt Title
|
|
182
|
-
|
|
183
|
-
Brief description of what this prompt does.
|
|
184
|
-
|
|
185
|
-
## Prerequisites
|
|
186
|
-
- List any required setup
|
|
187
|
-
- Dependencies or tools needed
|
|
188
|
-
- API keys or configurations
|
|
189
|
-
|
|
190
|
-
## Usage
|
|
191
|
-
```bash
|
|
192
|
-
aia prompt_name input_file.txt
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
## Customization
|
|
196
|
-
Explain how users can modify the prompt for their needs.
|
|
197
|
-
|
|
198
|
-
## Related Examples
|
|
199
|
-
- Link to similar or complementary examples
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
### Tool Examples
|
|
203
|
-
|
|
204
|
-
#### File Structure
|
|
205
|
-
```
|
|
206
|
-
docs/examples/tools/
|
|
207
|
-
├── index.md # Tools overview
|
|
208
|
-
├── tool_name.rb # Ruby tool implementation
|
|
209
|
-
└── tool_name_usage.md # Documentation
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
#### Tool Template
|
|
213
|
-
```ruby
|
|
214
|
-
# Tool implementation following RubyLLM::Tool pattern
|
|
215
|
-
class ToolName < RubyLLM::Tool
|
|
216
|
-
description "Brief description of tool functionality"
|
|
217
|
-
|
|
218
|
-
def method_name(parameter1, parameter2 = nil)
|
|
219
|
-
# Implementation with error handling
|
|
220
|
-
# Return structured results
|
|
221
|
-
end
|
|
222
|
-
|
|
223
|
-
private
|
|
224
|
-
|
|
225
|
-
def helper_method
|
|
226
|
-
# Internal helper methods
|
|
227
|
-
end
|
|
228
|
-
end
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
### MCP Client Examples
|
|
232
|
-
|
|
233
|
-
#### File Structure
|
|
234
|
-
```
|
|
235
|
-
docs/examples/mcp/
|
|
236
|
-
├── index.md # MCP overview
|
|
237
|
-
├── client_name.py # Python MCP client
|
|
238
|
-
├── client_name.js # Node.js MCP client
|
|
239
|
-
└── client_name_usage.md # Documentation
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
## Pull Request Process
|
|
243
|
-
|
|
244
|
-
### Before Submitting
|
|
245
|
-
1. **Test Your Changes**
|
|
246
|
-
```bash
|
|
247
|
-
rake test
|
|
248
|
-
rake integration
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
2. **Check Code Quality**
|
|
252
|
-
```bash
|
|
253
|
-
rubocop
|
|
254
|
-
reek
|
|
255
|
-
```
|
|
256
|
-
Note: `rubocop` and `reek` are not bundled dev dependencies. Install them manually if you wish to run these checks.
|
|
257
|
-
|
|
258
|
-
3. **Update Documentation**
|
|
259
|
-
- Add/update relevant documentation
|
|
260
|
-
- Include examples if applicable
|
|
261
|
-
- Update CHANGELOG.md
|
|
262
|
-
|
|
263
|
-
### Submitting the Pull Request
|
|
264
|
-
|
|
265
|
-
1. **Create Descriptive Title**
|
|
266
|
-
- Use the same format as commit messages
|
|
267
|
-
- Be specific about what changed
|
|
268
|
-
|
|
269
|
-
2. **Write Comprehensive Description**
|
|
270
|
-
```markdown
|
|
271
|
-
## Summary
|
|
272
|
-
Brief description of changes
|
|
273
|
-
|
|
274
|
-
## Changes Made
|
|
275
|
-
- List key changes
|
|
276
|
-
- Explain design decisions
|
|
277
|
-
- Note any breaking changes
|
|
278
|
-
|
|
279
|
-
## Testing
|
|
280
|
-
- Describe testing performed
|
|
281
|
-
- Include test results if relevant
|
|
282
|
-
|
|
283
|
-
## Documentation
|
|
284
|
-
- List documentation updates
|
|
285
|
-
- Include screenshots if applicable
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
3. **Checklist**
|
|
289
|
-
- [ ] Tests pass locally
|
|
290
|
-
- [ ] Code follows style guidelines
|
|
291
|
-
- [ ] Documentation updated
|
|
292
|
-
- [ ] CHANGELOG.md updated (if user-facing)
|
|
293
|
-
- [ ] No breaking changes (or documented)
|
|
294
|
-
|
|
295
|
-
### Review Process
|
|
296
|
-
- Maintainers will review your pull request
|
|
297
|
-
- Address feedback promptly and professionally
|
|
298
|
-
- Be open to suggestions and improvements
|
|
299
|
-
- Update your PR based on review comments
|
|
300
|
-
|
|
301
|
-
## Community Guidelines
|
|
302
|
-
|
|
303
|
-
### Communication
|
|
304
|
-
- **Be Respectful**: Treat all community members with respect
|
|
305
|
-
- **Be Constructive**: Provide helpful, actionable feedback
|
|
306
|
-
- **Be Patient**: Maintainers and contributors are volunteers
|
|
307
|
-
- **Be Collaborative**: Work together to improve the project
|
|
308
|
-
|
|
309
|
-
### Issue Reporting
|
|
310
|
-
- **Search First**: Check if the issue already exists
|
|
311
|
-
- **Be Specific**: Provide detailed reproduction steps
|
|
312
|
-
- **Include Context**: OS, Ruby version, AIA version
|
|
313
|
-
- **Provide Examples**: Include relevant code or configuration
|
|
314
|
-
|
|
315
|
-
### Feature Requests
|
|
316
|
-
- **Describe Use Case**: Explain why the feature is needed
|
|
317
|
-
- **Consider Alternatives**: Discuss other approaches
|
|
318
|
-
- **Be Open to Discussion**: Feature scope may evolve
|
|
319
|
-
|
|
320
|
-
## Security
|
|
321
|
-
|
|
322
|
-
### Reporting Security Issues
|
|
323
|
-
- **Do NOT** create public GitHub issues for security vulnerabilities
|
|
324
|
-
- Email security issues to: [maintainer-email]
|
|
325
|
-
- Include detailed description and reproduction steps
|
|
326
|
-
- Allow reasonable time for response before public disclosure
|
|
327
|
-
|
|
328
|
-
### Security Best Practices
|
|
329
|
-
- Never commit API keys or secrets
|
|
330
|
-
- Validate all user inputs
|
|
331
|
-
- Use secure defaults in configurations
|
|
332
|
-
- Follow principle of least privilege
|
|
333
|
-
|
|
334
|
-
## Recognition
|
|
335
|
-
|
|
336
|
-
### Contributors
|
|
337
|
-
All contributors are recognized in:
|
|
338
|
-
- CONTRIBUTORS.md file
|
|
339
|
-
- Release notes for significant contributions
|
|
340
|
-
- GitHub contributor statistics
|
|
341
|
-
|
|
342
|
-
### Types of Recognition
|
|
343
|
-
- **Code Contributors**: Code, tests, bug fixes
|
|
344
|
-
- **Documentation Contributors**: Guides, examples, documentation
|
|
345
|
-
- **Community Contributors**: Issue triage, user support
|
|
346
|
-
- **Maintainers**: Ongoing project stewardship
|
|
347
|
-
|
|
348
|
-
## Getting Help
|
|
349
|
-
|
|
350
|
-
### Development Questions
|
|
351
|
-
- **GitHub Discussions**: For general questions and ideas
|
|
352
|
-
- **Issues**: For specific bugs or feature requests
|
|
353
|
-
- **Documentation**: Check existing guides and examples
|
|
354
|
-
|
|
355
|
-
### Code Review
|
|
356
|
-
- Ask for reviews in PR comments
|
|
357
|
-
- Mention specific maintainers if needed
|
|
358
|
-
- Be patient - reviews take time
|
|
359
|
-
|
|
360
|
-
### Community Support
|
|
361
|
-
- Help other contributors
|
|
362
|
-
- Share knowledge and experience
|
|
363
|
-
- Mentor new contributors
|
|
364
|
-
|
|
365
|
-
## Release Process
|
|
366
|
-
|
|
367
|
-
### Version Management
|
|
368
|
-
AIA follows semantic versioning (SemVer):
|
|
369
|
-
- **MAJOR**: Breaking changes
|
|
370
|
-
- **MINOR**: New features, backward compatible
|
|
371
|
-
- **PATCH**: Bug fixes, backward compatible
|
|
372
|
-
|
|
373
|
-
### Release Schedule
|
|
374
|
-
- No fixed schedule - releases when ready
|
|
375
|
-
- Security fixes released promptly
|
|
376
|
-
- Feature releases coordinated with maintainers
|
|
377
|
-
|
|
378
|
-
## Thank You!
|
|
379
|
-
|
|
380
|
-
Thank you for considering contributing to AIA! Your contributions help make this tool better for everyone in the AI community.
|
|
381
|
-
|
|
382
|
-
Questions? Feel free to open an issue or start a discussion on GitHub.
|
|
383
|
-
|
|
384
|
-
---
|
|
385
|
-
|
|
386
|
-
*Last updated: February 2026*
|