Skip to content

Commit c324ba8

Browse files
ZviBaratzclaude
andcommitted
docs: restructure README for visual polish and navigation
Promote sample output above the fold, add badges and emoji headers, collapse reference sections behind <details> blocks, create separate audience paths for developers and reviewers. Move Help Wanted and Ways to Contribute to CONTRIBUTING.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 96c65f1 commit c324ba8

File tree

2 files changed

+141
-119
lines changed

2 files changed

+141
-119
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,23 @@ If ego-lint flags something incorrectly:
290290

291291
False positives in blocking rules (FAIL) are treated as high priority. False positives in advisory rules (WARN) are tracked and addressed in batches.
292292

293+
## Ways to Contribute
294+
295+
Beyond writing new rules:
296+
297+
- **Validate existing rules** — run ego-lint on extensions from your queue and report where it gets things right or wrong
298+
- **Propose severity changes** — if a WARN should be a FAIL (or vice versa), open an issue with your reasoning
299+
- **Report missing patterns** — rejection reasons ego-lint doesn't catch yet
300+
301+
### Help Wanted
302+
303+
Self-contained improvements where reviewer expertise would be especially valuable:
304+
305+
- **Polkit action ID validation** — verify `.policy` file exists with `org.gnome.shell.extensions.*` ID when `pkexec` is used
306+
- **Schema filename validation** — ensure `.gschema.xml` filename matches the schema ID inside
307+
- **Module-scope mutable state** — detect `Map`/`Set` at module level (mutable state outside `enable()`/`disable()`)
308+
- **New rejection patterns** — if you see a common rejection reason not covered by ego-lint, [open an issue](https://github.com/ZviBaratz/gnome-extension-reviewer/issues) with the pattern
309+
293310
## Rule Lifecycle
294311

295312
- New rules start as **advisory** (WARN) unless they correspond to a documented MUST requirement in the official guidelines

0 commit comments

Comments
 (0)