@@ -90,10 +90,8 @@ git checkout -b feature/your-feature-name
9090Branch naming conventions:
9191- ` feature/ ` - New features
9292- ` fix/ ` - Bug fixes
93- - ` docs/ ` - Documentation changes
94- - ` refactor/ ` - Code refactoring
95- - ` test/ ` - Test improvements
96- - ` chore/ ` - Maintenance tasks
93+ - ` hotfix/ ` - Hotfix
94+ - ` release/ ` - Release changes
9795
9896### 2. Make Your Changes
9997
@@ -110,12 +108,12 @@ Use descriptive commit messages:
110108
111109``` bash
112110# Good commit messages
113- git commit -m " Add : CloudWatch logging support"
114- git commit -m " Fix : Handle None values in Logger.format()"
115- git commit -m " Update : Improve type hints in Settings class"
116- git commit -m " Refactor : Simplify Timer context manager logic"
117- git commit -m " Test : Add edge cases for config loading"
118- git commit -m " Docs : Update contributing guidelines"
111+ git commit -m " add : CloudWatch logging support"
112+ git commit -m " fix : Handle None values in Logger.format()"
113+ git commit -m " update : Improve type hints in Settings class"
114+ git commit -m " refactor : Simplify Timer context manager logic"
115+ git commit -m " test : Add edge cases for config loading"
116+ git commit -m " docs : Update contributing guidelines"
119117
120118# Avoid
121119git commit -m " updates"
@@ -240,16 +238,6 @@ def calculate_total(items: list[float], tax_rate: float) -> float:
240238- ** Extract complex logic** into named functions
241239
242240### Ruff Rules
243-
244- All Ruff rules are enabled by default. Common violations to avoid:
245-
246- - ` E501 ` - Line too long (max 88 characters)
247- - ` F401 ` - Unused imports
248- - ` F841 ` - Unused variables
249- - ` N802 ` - Function name should be lowercase
250- - ` D100 ` - Missing docstring in public module
251- - ` S101 ` - Use of assert (allowed in tests only)
252-
253241Run ` uv run ruff check . ` to see all violations.
254242
255243## Testing Requirements
0 commit comments