chore(docs): update project-specific commit message guidelines in README and example file

Author: f

COMMIT_MESSAGE.md.example

@@ -0,0 +1,41 @@
+# Commit Message Guidelines
+
+This file provides project-specific context for AI-generated commit messages.
+Place this file as `COMMIT_MESSAGE.md` in one of these locations (searched in order):
+1. Project root directory
+2. `.git/` directory
+3. `.github/` directory
+
+## Project Context
+
+This is a git commit history rewriter tool that helps developers improve their commit messages using AI.
+
+## Commit Message Requirements
+
+- Always use conventional commit format: `type(scope): description`
+- Types: feat, fix, docs, style, refactor, test, chore, perf, ci, build, revert
+- Scopes for this project: cli, hooks, providers, core, docs
+- Keep the first line under 72 characters
+- Write in present tense ("add" not "added")
+- Focus on what and why, not how
+
+## Project-Specific Guidelines
+
+- When changing git hooks, mention which hooks are affected
+- When updating providers, specify which AI provider (OpenAI/Ollama)
+- Security-related changes should be clearly marked
+- Breaking changes should include BREAKING CHANGE in the message
+
+## Examples
+
+Good commit messages for this project:
+- `feat(hooks): add support for custom Ollama server URLs`
+- `fix(core): prevent console output from contaminating commit messages`
+- `docs(readme): add blog post link and improve security section`
+- `refactor(providers): split provider implementations into separate files`
+
+## Additional Notes
+
+- This tool is security-sensitive as it handles git history
+- Consider privacy implications when mentioning data handling
+- Emphasize user control and opt-in features

README.md

@@ -73,6 +73,7 @@ ollama serve
 - **Efficient processing** - Process only the last N commits with `--max-commits`
 - **Dry-run mode** - Preview changes before applying them
 - **Progress tracking** - Real-time progress indicators with colored output
+- **Custom context** - Project-specific guidelines via `COMMIT_MESSAGE.md` file
 
 ## Installation
 
@@ -161,41 +162,66 @@ git config hooks.providerModel "gpt-4"  # or "gpt-3.5-turbo", "llama3.2", etc.
 git config hooks.ollamaUrl "http://192.168.1.100:11434"
 ```
 
+### Custom Project Guidelines with `COMMIT_MESSAGE.md`
+
+You can provide project-specific commit message guidelines that the AI will follow by creating a `COMMIT_MESSAGE.md` file. The tool searches for this file in the following locations (in order):
+
+1. **Project root** - `./COMMIT_MESSAGE.md`
+2. **Git directory** - `./.git/COMMIT_MESSAGE.md`
+3. **GitHub directory** - `./.github/COMMIT_MESSAGE.md`
+
+Example `COMMIT_MESSAGE.md`:
+```markdown
+# Project Commit Guidelines
+
+## Requirements
+- Use conventional commits with these scopes: auth, api, ui, db
+- Include ticket numbers when available (e.g., JIRA-123)
+- Security changes must be clearly marked
+- Breaking changes need BREAKING CHANGE in the message
+
+## Project Context
+This is a financial services API that handles sensitive data.
+Emphasize security, compliance, and performance in commit messages.
+```
+
+See [`COMMIT_MESSAGE.md.example`](COMMIT_MESSAGE.md.example) in this repository for a complete example.
+
 ## Usage
 
 ### Command Examples
 
 ```bash
 # Using the full command name
-git-rewrite-commits [options]
+npx git-rewrite-commits [options]
 
 # Or using the short alias (grec)
-grec [options]
+npx grec [options]
 ```
 
 Common use cases:
 
 ```bash
 # Rewrite entire git history
-grec
+npx git-rewrite-commits
 
 # Preview changes without applying (dry run)
-grec --dry-run
+npx git-rewrite-commits --dry-run
 
 # Generate commit message for staged changes
-grec --staged
+npx git-rewrite-commits --staged
 
 # Process only last 10 commits
-grec --max-commits 10
+npx git-rewrite-commits --max-commits 10
 
 # Use custom AI model
-grec --model gpt-4
+npx git-rewrite-commits --model gpt-4
 
 # Use local AI with Ollama
-grec --provider ollama
+npx git-rewrite-commits --provider ollama
 
 # Install/update git hooks
-grec --install-hooks
+npx git-rewrite-commits --install-hooks
 ```
 
 ## Real-World Examples

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "git-rewrite-commits",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "AI-powered git commit message rewriter using OpenAI - rewrite your entire git history with better conventional commit messages",
   "type": "module",
   "main": "./dist/index.js",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "grec",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "Short alias for git-rewrite-commits - AI-powered git commit message rewriter",
   "type": "module",
   "bin": {
@@ -34,7 +34,7 @@
     "node": ">=16.0.0"
   },
   "dependencies": {
-    "git-rewrite-commits": "^0.7.2"
+    "git-rewrite-commits": "^0.7.3"
   },
   "publishConfig": {
     "access": "public"

packages/grec/package.json

@@ -310,6 +310,35 @@ export class GitCommitRewriter {
     return redacted;
   }
 
+  private findCommitMessageContext(): string | null {
+    // Search for COMMIT_MESSAGE.md in order of priority:
+    // 1. Current root directory
+    // 2. .git directory
+    // 3. .github directory
+    const searchPaths = [
+      path.join(process.cwd(), 'COMMIT_MESSAGE.md'),
+      path.join(process.cwd(), '.git', 'COMMIT_MESSAGE.md'),
+      path.join(process.cwd(), '.github', 'COMMIT_MESSAGE.md'),
+    ];
+
+    for (const filePath of searchPaths) {
+      try {
+        if (fs.existsSync(filePath)) {
+          const content = fs.readFileSync(filePath, 'utf-8');
+          if (this.options.verbose && !this.options.quiet) {
+            console.log(chalk.blue(`📝 Found custom commit message context at: ${path.relative(process.cwd(), filePath)}`));
+          }
+          return content.trim();
+        }
+      } catch (error) {
+        // Continue searching if file can't be read
+        continue;
+      }
+    }
+
+    return null;
+  }
+
   private async generateCommitMessage(
     diff: string,
     files: string[],
@@ -319,6 +348,9 @@ export class GitCommitRewriter {
       // Redact sensitive data from diff before sending to AI provider
       const redactedDiff = this.redactSensitivePatterns(diff);
 
+      // Look for custom commit message context
+      const customContext = this.findCommitMessageContext();
+      
       let formatInstructions = '';
 
       if (this.options.template) {
@@ -350,7 +382,7 @@ Example: If template is "[JIRA-XXX] type: message", generate something like "[JI
         // User provided custom prompt - use it with basic context
         prompt = `You are a git commit message generator. Analyze the following git diff and file changes, then ${this.options.prompt}
 
-Old commit message: "${oldMessage}"
+${customContext ? `Project-specific guidelines:\n${customContext}\n\n` : ''}Old commit message: "${oldMessage}"
 
 Files changed:
 ${files.join('\n')}
@@ -366,7 +398,7 @@ Return ONLY the commit message, nothing else.`;
         // Use default prompt with all standard instructions
         prompt = `You are a git commit message generator. Analyze the following git diff and file changes, then generate a clear, concise commit message.
 
-Old commit message: "${oldMessage}"
+${customContext ? `Project-specific guidelines:\n${customContext}\n\n` : ''}Old commit message: "${oldMessage}"
 
 Files changed:
 ${files.join('\n')}