Skip to content

Commit acf70b4

Browse files
Update CLAUDE.md
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 239e41a commit acf70b4

File tree

1 file changed

+1
-53
lines changed

1 file changed

+1
-53
lines changed

CLAUDE.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -244,61 +244,9 @@ All workflows use the same nox commands as local development.
244244

245245
## Pull Request Process
246246

247-
For comprehensive contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md) in the repository root.
247+
For comprehensive contribution guidelines, including detailed steps for creating and reviewing Pull Requests, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) in the repository root.
248248

249249
**Code of Conduct**: All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md). We maintain a welcoming, inclusive, and harassment-free environment for everyone.
250-
251-
### Creating a Pull Request
252-
253-
When creating a PR, use the template at `.github/pull_request_template.md` (auto-populated by GitHub):
254-
255-
**Required before submission:**
256-
1. Run all quality checks:
257-
```bash
258-
uv run nox -s fmt
259-
uv run nox -s lint -- --pyright --ruff
260-
uv run nox -s test
261-
uv run pre-commit run --all-files
262-
```
263-
264-
2. Fill out all sections of the PR template:
265-
- **Summary**: Brief description and context
266-
- **Type of Change**: Select applicable change types
267-
- **Changes Made**: List main changes
268-
- **Testing**: Confirm all test commands passed
269-
- **Pre-Submission Checklist**: Verify all items
270-
271-
3. Ensure documentation is updated if needed
272-
273-
### Reviewing Pull Requests
274-
275-
Reviewers should use `.github/pull_request_template.md` for comprehensive reviews:
276-
277-
**Key review areas:**
278-
- Code Quality: Style, type safety, naming, complexity
279-
- Testing: Coverage ≥75%, edge cases, test quality
280-
- Functionality: Logic correctness, error handling
281-
- Documentation: Docstrings, README, inline comments
282-
- Dependencies: Justified additions, `uv.lock` updated
283-
- Security: Input validation, no secrets committed
284-
285-
**Review workflow:**
286-
1. Check that author completed pre-submission checklist
287-
2. Review code changes using the checklist
288-
3. Run tests locally if needed
289-
4. Provide actionable feedback
290-
5. Approve or request changes
291-
292-
### PR Template Sections
293-
294-
The template includes:
295-
- **Summary & Context** - What and why
296-
- **Type of Change** - 8 predefined categories
297-
- **Testing** - Commands run and results
298-
- **Pre-Submission Checklist** - 12 essential items grouped by category
299-
- **Breaking Changes** - Flag and document if applicable
300-
- **Additional Notes** - Screenshots, performance notes, etc.
301-
302250
## Environment Variables
303251

304252
Critical environment variables (set in `.env.local`):

0 commit comments

Comments
 (0)