Skip to content

Commit d195787

Browse files
committed
docs: update CONTRIBUTING.md with correct commands and tool names
- Update tool references from pia_search to pia_search_content - Fix pre-commit configuration to match actual .pre-commit-config.yaml - Update pre-commit hooks description to reflect actual functionality: - File formatting (trailing whitespace, end-of-file) - YAML/JSON validation - Merge conflict detection - Large file prevention - Verify all commands work correctly with current project structure - Update code examples with current function names All commands and examples now match the current implementation
1 parent 690d49e commit d195787

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,10 @@ pre-commit install
7878
Our pre-commit configuration (`.pre-commit-config.yaml`) automatically:
7979

8080
- **Code Formatting**: Runs `black` to format Python code
81-
- **Import Sorting**: Organizes imports consistently
82-
- **Linting**: Checks for code quality issues
83-
- **File Checks**: Ensures proper file formatting and structure
81+
- **File Checks**: Removes trailing whitespace, fixes end-of-file formatting
82+
- **YAML/JSON Validation**: Checks syntax of configuration files
83+
- **Merge Conflict Detection**: Prevents committing unresolved conflicts
84+
- **Large File Prevention**: Blocks accidentally committed large files
8485

8586
### Running Pre-commit Manually
8687

@@ -101,15 +102,22 @@ Our `.pre-commit-config.yaml` includes:
101102

102103
```yaml
103104
repos:
105+
- repo: https://github.com/pre-commit/pre-commit-hooks
106+
rev: v4.4.0
107+
hooks:
108+
- id: trailing-whitespace
109+
- id: end-of-file-fixer
110+
- id: check-yaml
111+
- id: check-json
112+
- id: check-added-large-files
113+
- id: check-merge-conflict
104114
- repo: https://github.com/psf/black
105115
rev: 23.3.0
106116
hooks:
107117
- id: black
108118
language_version: python3.11
109119
```
110120
111-
Additional hooks may be added as the project grows.
112-
113121
## 🛠️ Making Changes
114122
115123
### Development Workflow
@@ -185,7 +193,7 @@ We use [Conventional Commits](https://www.conventionalcommits.org/) format:
185193
feat: add new OData string function support
186194
fix: resolve API key validation error
187195
docs: update README with filter examples
188-
test: add unit tests for pia_search tool
196+
test: add unit tests for pia_search_content tool
189197
chore: update dependencies to latest versions
190198
```
191199

@@ -217,7 +225,7 @@ python -m pytest -v
217225
### Writing Tests
218226

219227
- Place tests in the `tests/` directory
220-
- Use descriptive test names: `test_pia_search_with_valid_filters`
228+
- Use descriptive test names: `test_pia_search_content_with_valid_filters`
221229
- Mock external API calls
222230
- Test both success and error scenarios
223231
- Aim for high test coverage (>90%)
@@ -355,7 +363,7 @@ import mcp.types as types
355363
logger = logging.getLogger(__name__)
356364

357365

358-
async def handle_pia_search(arguments: Dict[str, Any]) -> List[types.TextContent]:
366+
async def handle_pia_search_content(arguments: Dict[str, Any]) -> List[types.TextContent]:
359367
"""Handle PIA search requests with OData filtering.
360368
361369
Args:

0 commit comments

Comments
 (0)