Skip to content

Commit 0f3b8a4

Browse files
committed
docs: update contributing
1 parent a1596ed commit 0f3b8a4

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

contributing/CODE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ Some files that use CPP language extension cannot be formatted as a whole, so in
3636
- Do not add comments like "wire format encoding" (Encoding class is always wire format) or "check if X" when the function name already says that
3737
- Assume a competent Haskell reader
3838

39+
**Diff and refactoring:**
40+
- Avoid unnecessary changes and code movements
41+
- Never do refactoring unless it substantially reduces cost of solving the current problem, including the cost of refactoring
42+
- Aim to minimize the code changes - do what is minimally required to solve users' problems
43+
3944
### Haskell Extensions
4045
- `StrictData` enabled by default
4146
- Use STM for safe concurrency

contributing/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Please discuss the problem you want to solve and your detailed implementation pl
1717
This files can be used with LLM prompts, e.g. if you use Claude Code you can create CLAUDE.md file in project root importing content from these files:
1818

1919
```markdown
20+
@README.md
2021
@contributing/PROJECT.md
2122
@contributing/CODE.md
2223
```

0 commit comments

Comments
 (0)