Merge pull request #12 from sanderkooger/feat/update-readme-workflow

docs: Update README with development workflow

fixes #6

Author: sanderkooger

.clinerules

@@ -14,17 +14,29 @@ This file stores agreed-upon conventions and prompt context for interacting with
 - Conform code you write with the rules in .prettierrc
 - Prefer arrow functions
 
-## GitHub MCP Usage
-
-- Use GitHub MCP tools only for:
-  - Issue/pull request comments
-  - Creating/updating issues
-  - Repository metadata operations
-  - updating secrets
-  - etc
-- For commits/branches/pushes, use CLI commands
-- Never store GitHub credentials in code/configs
-- always read the .git/config, or root package.json of the repo you are working on to determine the repository owner and name
+## GitHub Integration Rules
+
+### Local Operations (Use CLI)
+
+- All Git operations (commits/branches/pushes):
+  - Must use raw git commands
+  - Format commit messages directly via CLI
+  - Never use `npm run commit` or GitHub MCP tools
+
+### Platform Interactions (Use MCP)
+
+- Limit GitHub MCP to:
+  - PR management/comments
+  - Issue tracking
+  - Repository metadata
+  - Secret management
+
+### Security & Configuration
+
+- Never store credentials in code/configs
+- Derive repository info from:
+  - Local .git/config
+  - package.json metadata
 
 ## RagDocs Usage
 
@@ -36,7 +48,7 @@ This file stores agreed-upon conventions and prompt context for interacting with
 
 - Never modify package.json directly - always use `npm install <package>` commands
 - Prefer exact version specifications when adding dependencies
-- Ensure< package-lock.json is committed after dependency changes
+- Ensure package-lock.json is committed after dependency changes
 
 ## Testing Conventions
 

.commitlintrc.ts

@@ -11,16 +11,17 @@ const Configuration: UserConfig = {
       RuleConfigSeverity.Error,
       'always',
       [
+        'build',
         'chore',
+        'ci',
+        'docs',
         'feat',
         'fix',
-        'docs',
-        'style',
+        'perf',
         'refactor',
-        'test',
         'revert',
-        'build',
-        'ci'
+        'style',
+        'test'
       ]
     ]
   },

CONTRIBUTING.md

@@ -32,8 +32,6 @@ npm run format
 
 5. Check code quality with ESLint (using eslint.config.ts config):
 
-gh auth
-
 ```bash
 npm run lint
 ```
@@ -63,6 +61,12 @@ We enforce commit standards through:
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm run lint
+
+# .husky/commit-msg
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit "$1"
 ```
 
 1. Stage changes with `git add`
@@ -165,34 +169,51 @@ describe('jestTestFunction', () => {
    - Coverage tracked via Codecov
    - Failure blocks merge
 
-## Commit Message Format
+## Commit Message Guide
+
+Use the interactive wizard for standardized commits:
+
+```bash
+npm run commit
+```
 
-We enforce [Conventional Commits](https://www.conventionalcommits.org) specification:
+### Format
 
 ```
-<type>(<scope>): <description>
+type(scope): description [issue-number]
 ```
 
-### Allowed Types:
+### Valid Types:
 
-- chore: Maintenance tasks
-- feat: New features
-- fix: Bug fixes
+- feat: New feature (triggers minor release)
+- fix: Bug fix (triggers patch release)
+- perf: Performance improvement (triggers patch release)
 - docs: Documentation changes
 - style: Code formatting
 - refactor: Code refactoring
 - test: Test updates
-- revert: Revert changes
-- build: Build system updates
+- chore: Maintenance tasks (including releases)
+
+The Commitizen wizard will guide you through these types. Our configuration
+extends @commitlint/config-conventional which also recognizes:
+
+- build: Changes to build process (not currently used)
+- ci: CI configuration changes (not currently used)
+- revert: Revert commits (auto-generated)
+
+Official @commitlint/config-conventional types include:
+
+- build: Changes that affect the build system
 - ci: CI configuration changes
+- revert: Revert a previous commit
 
-Examples:
+### Example:
 
-```bash
-feat: add documentation search endpoint
-fix: resolve timeout issues in queue processing
-docs: update API reference documentation
 ```
+fix(commit): Add interactive commit wizard [GH-6]
+```
+
+The wizard will validate your input and ensure proper formatting.
 
 ## Pull Request Process
 

README.md

@@ -228,6 +228,30 @@ ollama list
 
 This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.
 
+## Development Workflow
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Make your changes following the coding standards in CONTRIBUTING.md
+
+3. Commit changes using Commitizen:
+
+```bash
+npm run commit
+```
+
+4. Push to your feature branch:
+
+```bash
+git push origin feat/your-feature
+```
+
+5. Create a pull request through GitHub's interface
+
 ## Contributing
 
 We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines, but here are the basics: