Skip to content

Commit 840f557

Browse files
author
RandomCrocodile
committed
docs: broaden issue and PR rules to cover our own repo, not just mkaring
1 parent 1d313b7 commit 840f557

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

CLAUDE.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -73,45 +73,47 @@ main — stable, releases only
7373

7474
---
7575

76-
## Upstream Integration Rules (MANDATORY)
76+
## Issue & PR Rules (MANDATORY)
7777

78-
Before cherry-picking or adapting ANY change from `mkaring/ConfuserEx`:
78+
These rules apply to ALL work — our own repo (`mcpolo99/ConfuserExx`) and upstream (`mkaring/ConfuserEx`).
7979

80-
### 1. Verify status first
80+
### 1. Before starting any work
8181

82-
- Check `gh issue view <number> --repo mkaring/ConfuserEx` for current status
83-
- Check if a fix was already merged upstream after the issue was filed
84-
- If the issue is closed/fixed upstream, verify our fork already has the fix
85-
- Close our corresponding issue if already resolved
86-
- **Only work on OPEN issues and PRs** — skip closed, wontfix, duplicate, invalid
82+
- Check if the issue/PR is still open and relevant
83+
- Check if a fix already exists in our codebase (search commits, PRs, branches)
84+
- Close issues that are already resolved — comment with the commit hash
85+
- **Only work on OPEN issues** — skip closed, wontfix, duplicate, invalid
8786

88-
### 2. Review the actual code
89-
90-
- Fetch the PR: `git fetch mkaring pull/<number>/head:pr-<number>`
91-
- Read the actual diff, not just the title
92-
- Check if the change conflicts with our existing modifications
93-
- Test that the cherry-pick applies cleanly
94-
- **Do NOT blindly cherry-pick — understand what the code does first**
95-
96-
### 3. Analyse code quality
87+
### 2. Review all PRs thoroughly
9788

89+
- Read the actual diff, not just the title or description
9890
- Review for correctness, not just intent
9991
- Check for regressions, missing edge cases, or poor patterns
10092
- Verify the fix actually solves the stated problem
101-
- Check if there's a better approach than the upstream PR
93+
- Check if there's a better approach
94+
- **Do NOT merge without understanding what the code does**
95+
96+
### 3. When cherry-picking from mkaring/ConfuserEx
97+
98+
- Fetch the PR: `git fetch mkaring pull/<number>/head:pr-<number>`
99+
- Check if the change conflicts with our existing modifications
100+
- Test that the cherry-pick applies cleanly
101+
- **Do NOT blindly cherry-pick — review the code first**
102102

103-
### 4. When creating issues from upstream
103+
### 4. When creating issues
104104

105-
- Create matching issues on both private and public repos
106-
- Reference the upstream issue number in the description
105+
- For upstream issues: create matching issues on our repo, reference the original
107106
- Mention the original reporter when posting fixes
108107
- Tag with appropriate labels (enhancement, bug, upstream)
108+
- Include clear reproduction steps and expected vs actual behavior
109109

110-
### 5. PR iteration rules
110+
### 5. PR workflow
111111

112112
- Always push fixes to the **same branch** — never create replacement PRs
113113
- When a PR gets review feedback, push additional commits to the same branch
114114
- When a tester reports issues, fix on the same branch and ask for re-test
115+
- Reference the issue number in commits: `fix: handle timeout (#42)`
116+
- PR description must include `Fixes #<number>` to auto-close the issue
115117

116118
---
117119

0 commit comments

Comments
 (0)