Skip to content

Commit eaa263b

Browse files
docs: clarify global config as planned feature
• Remove misleading claim about global config fallback • Add Global Configuration to Planned Features section • Document use cases and OS-specific file locations • Link from configuration discovery section to planned features • Ensures documentation accurately reflects current implementation
1 parent caa480f commit eaa263b

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,8 @@ See [`docs/CONFIG_SCHEMA.md`](docs/CONFIG_SCHEMA.md) for complete configuration
289289

290290
**Configuration discovery:**
291291
- Searches from current directory up to project root
292-
- Falls back to global configuration if available
293292
- Uses sensible defaults if no configuration found
293+
- Global configuration support is planned for future releases (see [Planned Features](#planned-features))
294294

295295
---
296296

@@ -382,4 +382,25 @@ If you have questions or need clarification, feel free to open a discussion or i
382382

383383
## Planned Features
384384

385-
_No planned features at this time. Check back later or open an issue to suggest new features!_
385+
### Global Configuration
386+
387+
Support for user-level global configuration files to enable consistent commit conventions across multiple projects. This will allow you to:
388+
389+
- Set default commit types and preferences in a single location
390+
- Apply your preferred commit conventions to all projects automatically
391+
- Override global settings on a per-project basis when needed
392+
393+
**Use cases:**
394+
- Developers working across multiple repositories who want consistent commit message formats
395+
- Teams that want to standardize commit conventions organization-wide
396+
- Personal projects where you want the same commit types everywhere
397+
398+
The global configuration will be stored in OS-specific locations:
399+
- **macOS/Linux**: `~/.labcommitr.config.yaml` or XDG config directory
400+
- **Windows**: `%USERPROFILE%\.labcommitr.config.yaml` or AppData directory
401+
402+
Project-specific configurations will always take precedence over global settings.
403+
404+
---
405+
406+
_Have a feature idea? Open an issue to suggest new features!_

0 commit comments

Comments
 (0)