You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# MANDATORY: Use git worktrees for all branch work
2
2
3
-
To analyze open issues, generate prompts, and launch parallel worker agents, follow `agents/coordinator_guide.md`. This uses the GitHub issue tools in `~/git/lab_tools/github/` — see `agents/github_tools_guide.md` for the bitsandbytes-specific reference.
3
+
NEVER work on a fix or feature branch inside the main `~/git/bitsandbytes` checkout. Always create a worktree first:
This keeps the main checkout clean and allows parallel sessions. If you are already inside a worktree directory, you do not need to create another one.
12
+
13
+
**Before creating a worktree**, check the worktree registry for existing ones — see the Git Worktrees section in `~/.claude/CLAUDE.md`. Bitsandbytes-specific naming conventions: `agents/worktree_guide.md`. General worktree guide: `~/git/lab_tools/worktree_guide.md`.
14
+
15
+
# MANDATORY: Check for existing PRs before starting work
6
16
7
-
To work on multiple branches at once, use git worktrees:
17
+
Before working on any issue, check whether a PR already exists:
gh pr list --search "issue-number OR keyword" --state open
13
21
```
14
22
15
-
Full guide: `agents/worktree_guide.md`
23
+
If a PR exists, review and build on it instead of starting from scratch. Do not create duplicate work.
16
24
17
-
# Testing
25
+
# MANDATORY: Run linting before every pull request
18
26
19
-
Run the test suite with 4 parallel workers (optimal for any machine):
27
+
Before pushing a PR branch, you MUST run the full pre-commit suite. CI will reject PRs that fail any check:
20
28
21
29
```bash
22
-
pytest tests/ -v --tb=short -n 4
30
+
pre-commit run --all-files
23
31
```
24
32
25
-
Best practices, benchmark data, and known architecture-specific issues: `agents/testing_guide.md`
33
+
This runs ruff, ruff format, typos, trailing-whitespace, clang-format, and all other CI lint hooks. Review and commit any changes it makes. Do NOT run only `ruff check` and `ruff format` — those are just 2 of 10 hooks. Full details: `agents/linting_guide.md`
34
+
35
+
# Testing: only run relevant tests
36
+
37
+
Do NOT run the full test suite — it takes 10+ minutes. Instead, run only the tests that cover the code you changed:
The full suite will be run separately. Best practices and known issues: `agents/testing_guide.md`
44
+
45
+
# Agent Dispatch (the "Dispatcher" role)
46
+
47
+
To triage open GitHub issues, generate prompt files, and launch parallel worker agents, read `agents/dispatch_guide.md`. If told "you're the Dispatcher" or "please read the Dispatch Guide," that's what this refers to. The dispatch workflow uses the GitHub issue tools in `agents/` — see `agents/github_tools_guide.md` for the bitsandbytes-specific reference.
48
+
49
+
# Issue maintenance and triage
50
+
51
+
To identify and close stale, duplicate, or resolved issues: `agents/issue_maintenance_guide.md`. Common closeable patterns (old CUDA setup, Windows pre-support, third-party app issues, etc.) are cataloged in `agents/issue_patterns.md`.
52
+
53
+
# Pull request review
54
+
55
+
When tasked with reviewing a pull request, you MUST read these guides before starting the review:
56
+
57
+
1.`agents/pr_review_guide.md` — The complete review workflow (classification, checklists, verdict format, and posting instructions). This is the primary guide; follow its steps sequentially.
58
+
2.`agents/architecture_guide.md` — Codebase architecture and patterns
The majority of bitsandbytes is licensed under MIT, however portions of the project are available under separate license terms: PyTorch is licensed under the BSD license.
2
+
3
+
The NVFP4 GEMM kernel in `csrc/qutlass/` is derived from [QuTLASS](https://github.com/IST-DASLab/qutlass) by Roberto L. Castro (IST Austria), licensed under the Apache License 2.0.
4
+
5
+
[CUTLASS](https://github.com/NVIDIA/cutlass) by NVIDIA is included as a submodule in `third_party/cutlass/`, licensed under the BSD 3-Clause License.
0 commit comments