|
| 1 | +# Team Configuration Files |
| 2 | + |
| 3 | +> Shared configuration files for development tools and team workflows |
| 4 | +
|
| 5 | +--- |
| 6 | + |
| 7 | +## Purpose |
| 8 | + |
| 9 | +This folder contains team-wide configuration files that are: |
| 10 | +- ✅ **Committed to Git** (shared with all team members) |
| 11 | +- ✅ **IDE/tool agnostic** (or include examples for multiple tools) |
| 12 | +- ✅ **Stable and tested** (not experimental) |
| 13 | + |
| 14 | +**Not for**: |
| 15 | +- ❌ Personal preferences (use your own local configs) |
| 16 | +- ❌ Sensitive data (credentials, tokens, etc.) |
| 17 | +- ❌ Auto-generated files (build artifacts, etc.) |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Structure |
| 22 | + |
| 23 | +``` |
| 24 | +configs/ |
| 25 | +├── README.md # This file |
| 26 | +├── .editorconfig # Cross-IDE formatting (indent, EOL, etc.) |
| 27 | +├── .eslintrc.example # Example ESLint config for new team members |
| 28 | +└── prettier.example.json # Example Prettier config (if team uses it) |
| 29 | +``` |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +## How to Use |
| 34 | + |
| 35 | +### For New Team Members |
| 36 | + |
| 37 | +1. Review existing config files in this folder |
| 38 | +2. Copy example files to your local workspace (if needed) |
| 39 | +3. Customize for your personal workflow |
| 40 | +4. **Do NOT commit personal customizations back here** |
| 41 | + |
| 42 | +### For Team Leads |
| 43 | + |
| 44 | +When adding a new config: |
| 45 | +1. Verify it works across different environments (macOS, Linux, Windows) |
| 46 | +2. Document what the config does and why it's needed |
| 47 | +3. Get team consensus before committing (PR review) |
| 48 | +4. Update this README if adding a new file type |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## Examples |
| 53 | + |
| 54 | +### ESLint Config |
| 55 | + |
| 56 | +If the team agrees on ESLint rules, add `.eslintrc.example`: |
| 57 | +```json |
| 58 | +{ |
| 59 | + "extends": ["eslint:recommended"], |
| 60 | + "rules": { |
| 61 | + "no-console": "warn", |
| 62 | + "semi": ["error", "always"] |
| 63 | + } |
| 64 | +} |
| 65 | +``` |
| 66 | + |
| 67 | +Team members copy to `.eslintrc.json` (which is in `.gitignore`). |
| 68 | + |
| 69 | +### EditorConfig |
| 70 | + |
| 71 | +Cross-IDE formatting rules (works in VS Code, IntelliJ, etc.): |
| 72 | +```ini |
| 73 | +# .editorconfig |
| 74 | +root = true |
| 75 | + |
| 76 | +[*] |
| 77 | +charset = utf-8 |
| 78 | +indent_style = space |
| 79 | +indent_size = 2 |
| 80 | +end_of_line = lf |
| 81 | +trim_trailing_whitespace = true |
| 82 | +insert_final_newline = true |
| 83 | +``` |
| 84 | + |
| 85 | +This file is committed as `.editorconfig` (no `.example` needed). |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +## Related |
| 90 | + |
| 91 | +- **`.claude/`**: Personal AI assistant files (NOT committed, see `.gitignore`) |
| 92 | +- **`docs/team/patterns/`**: Code patterns and architectural decisions |
| 93 | +- **`docs/team/runbooks/`**: Operational procedures and debugging guides |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +**Last Updated**: 2026-03-03 |
| 98 | +**Owner**: ACM Team |
0 commit comments