nadavWeisler / nadavWeisler/MedCodeTranslator

[Docs] Reassess issue templates after first community reports

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
7m
Merged PRs (30d)
7

Description

Problem summary

Issue templates were designed before community usage. After the first batch of real reports, prompts and labels should be tightened based on what produces ambiguous or incomplete tickets.

Affected area

  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/ISSUE_TEMPLATE/data_issue.yml
  • CONTRIBUTING.md

Expected behavior

Issue forms consistently produce actionable tickets with platform, scheme, repro steps, and acceptance criteria.

Acceptance criteria

  • Review first 5+ submitted issues for missing fields or confusion.
  • Update templates to reduce ambiguity (e.g. add ATC hierarchy schemes to data issue dropdown).
  • Align template labels with labels actually used on the repo.
  • Update CONTRIBUTING.md label taxonomy to match repo labels or create missing labels.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the first 5+ submitted issues, then compare their missing or confusing information with .github/ISSUE_TEMPLATE/bug_report.yml, feature_request.yml, data_issue.yml, and CONTRIBUTING.md. Check the repository's labels before revising prompts, dropdowns, and taxonomy; done means the templates consistently request actionable details and their labels match the repo.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.