Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions docs/community/LABELS_AUDIT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Good First Issue – Labels Audit

**Branch:** `community/labels-audit`
**Goal:** Lower the entry barrier for new contributors by labeling easy, newcomer-friendly tasks.

## Criteria

Tasks chosen for **good first issue**:

- Do **not** require deep Soroban-internals knowledge.
- Are scoped (e.g. docs, help text, UX, tests, tooling).
- Examples: help text improvements, doc updates, Docker/UX, small tests, QA tooling.

## List of Updated Issues

| # | Title | Rationale |
|-----|-----------------------------------------------------------------------|-----------|
| 32 | Source ID/Link | Documentation; already had label. |
| 81 | 29. [Decoder] Implement Trace visualization in CLI | Scoped decoder/CLI work; no Soroban internals. |
| 84 | 32. [Decoder] Suggestion engine for common errors | Help text / UX; error messages. |
| 86 | 34. [UX] Create Dockerfile for reproducible environment | DevOps/UX; no core logic. |
| 87 | 35. [UX] Add doctor command for environment verification | UX/tooling; env checks. |
| 114 | 62. [QA] Implement static analysis for Rust simulator | Tooling/QA; script or config. |
| 116 | 64. [QA] Implement dead code detection for Go codebase | Tooling/QA; script or linter. |
| 130 | 78. [Docs] Add "Cookbook" for common debugging scenarios | Documentation. |
| 131 | 79. [Community] Add "Good First Issue" labels | Meta community task. |
| 162 | 59. [Test] Add unit tests for ledger entry hashing | Table-driven tests; no Soroban internals. |

**Total:** 10 issues labeled (or to be labeled) with **good first issue**.

## Verification

- Filter by label [good first issue](https://github.com/dotandev/hintents/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and confirm count ≥ 10.
- This PR does not change application code; only labels (and this doc + script) are added.

## Applying the labels

- **Option A (UI):** Open each issue above and add the label **good first issue** in the GitHub UI.
- **Option B (script):** From repo root, with a `GITHUB_TOKEN` that has `issues: write`:

```bash
export GITHUB_TOKEN="your_token"
./scripts/label-good-first-issue.sh
```

Script repo default: `dotandev/hintents`. Override with `GITHUB_REPO=owner/repo` if needed.

## Completing this issue

To satisfy **Success Criteria: At least 10 issues labeled with "good first issue"** and close the issue:

1. **Apply labels** (one of):
- Run the script: `export GITHUB_TOKEN=your_token && ./scripts/label-good-first-issue.sh` (from repo root).
- Or add the label **good first issue** manually in the GitHub UI to each of the 10 issues in the table above.
2. **Verify:** Open [good first issue filter](https://github.com/dotandev/hintents/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and confirm ≥ 10 issues, or run `./scripts/verify-good-first-issue-labels.sh` (no token needed).
3. **Close the issue** (e.g. reference this PR or audit doc in a comment, then close).
Loading