Skip to content

Commit f45a98d

Browse files
nullvariantclaude
andauthored
docs: add naming conventions, PR template, and remove concrete values (#230)
* docs: add naming conventions, PR template, and remove concrete values Add function naming conventions section to ARCHITECTURE.md: - Naming rules table (is*, has*, validate*, *OrThrow, assert*, etc.) - Prohibited patterns list - Terminology definitions (valid/secure/safe) Add ESLint exclusion patterns section: - Document intentional lint rule bypasses - Prevent accidental removal of necessary exclusions Remove concrete values to prevent documentation drift: - Remove line counts, file counts, validator counts - Remove line number references in code examples - Replace specific numbers with generic terms (e.g., "Multi-Layer") - Reference source files as single source of truth Create .github/PULL_REQUEST_TEMPLATE.md: - General checklist (tests, linter, coverage) - Naming conventions checklist - Security checklist 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * chore: bump version to 0.14.4 and update CHANGELOG - Add CHANGELOG entry for 0.14.4 - Bump package.json version from 0.14.3 to 0.14.4 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 * style: fix markdown table column alignment per Restyled suggestions 🖥️ IDE: [Cursor](https://cursor.sh) 🔌 Extension: [Claude Code](https://claude.ai/download) Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Model-Raw: claude-opus-4-5-20251101 --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 2f5eb1e commit f45a98d

5 files changed

Lines changed: 181 additions & 89 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Summary
2+
3+
<!-- Brief description of what this PR does -->
4+
5+
## Changes
6+
7+
<!-- List of changes -->
8+
9+
-
10+
11+
## Checklist
12+
13+
### General
14+
15+
- [ ] Tests pass (`npm test`)
16+
- [ ] Linter passes (`npm run lint`)
17+
- [ ] Coverage not decreased (`npm run test:coverage`)
18+
19+
### Naming Conventions (if adding/renaming functions)
20+
21+
- [ ] `is*` functions return `boolean` only
22+
- [ ] `has*` functions return `boolean` only
23+
- [ ] `validate*` functions return result object (not void)
24+
- [ ] Functions that throw use `*OrThrow` or `assert*` prefix
25+
- [ ] No `check*` prefix used for pure predicates
26+
- [ ] See [ARCHITECTURE.md](extensions/git-id-switcher/docs/ARCHITECTURE.md#function-naming-conventions)
27+
28+
### Security (if touching validation/security code)
29+
30+
- [ ] No new magic numbers (use constants from `src/core/constants.ts`)
31+
- [ ] No new regex literals (use patterns from `src/validators/common.ts`)
32+
- [ ] Security-critical changes have `// SECURITY:` comments

extensions/git-id-switcher/CHANGELOG.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.14.4] - 2026-01-25
11+
12+
### Changed
13+
14+
- **ARCHITECTURE.md Improvements**: Enhanced documentation maintainability
15+
- Added "Function Naming Conventions" section with naming rules table
16+
- Added "ESLint Exclusion Patterns" section documenting intentional lint bypasses
17+
- Removed concrete values (line counts, file counts, validator counts) to prevent documentation drift
18+
- Replaced specific numbers with generic terms (e.g., "Multi-Layer" instead of "2 Layers")
19+
20+
### Added
21+
22+
- **PR Template**: Created `.github/PULL_REQUEST_TEMPLATE.md`
23+
- General checklist (tests, linter, coverage)
24+
- Naming conventions checklist for function additions/renames
25+
- Security checklist for validation/security code changes
26+
1027
## [0.14.3] - 2026-01-25
1128

1229
### Security

0 commit comments

Comments
 (0)