Skip to content

Commit 7feb0e6

Browse files
authored
Polish contributor support paths and issue routing. (#2)
Add a support guide, surface Discussions in the docs, and split guideline compatibility reports from generic bugs and feature requests so outside contributors know where to go. Made-with: Cursor
1 parent 6fb0e40 commit 7feb0e6

7 files changed

Lines changed: 112 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ body:
77
attributes:
88
value: |
99
Thanks for reporting this. Please include the exact command and enough input context to reproduce the issue.
10+
If the problem is really about a specific public guideline converting or parsing badly, use the guideline compatibility template instead.
1011
1112
- type: input
1213
id: version

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ contact_links:
33
- name: Questions and ideas
44
url: https://github.com/myceldigital/herald/discussions
55
about: Use GitHub Discussions for open-ended questions, design ideas, or exploratory conversations.
6+
- name: Security reporting
7+
url: https://github.com/myceldigital/herald/security/advisories/new
8+
about: Report security-sensitive issues privately instead of opening a public issue.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ body:
77
attributes:
88
value: |
99
Please focus on the real workflow or guideline problem you are trying to solve.
10+
If your request is mainly "Herald should support this public guideline better", use the guideline compatibility template instead.
1011
1112
- type: textarea
1213
id: use_case
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Guideline compatibility report
2+
description: Report a real public guideline that converts or parses poorly
3+
title: "[Guideline]: "
4+
labels: ["help wanted", "documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this when Herald struggles with a real public guideline and you want to point maintainers at a concrete parsing target.
10+
11+
- type: input
12+
id: source_url
13+
attributes:
14+
label: Official public source URL
15+
placeholder: e.g. https://www.nice.org.uk/guidance/...
16+
validations:
17+
required: true
18+
19+
- type: input
20+
id: publisher
21+
attributes:
22+
label: Publisher
23+
placeholder: e.g. NICE, WHO, SIGN, CDC
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: observed_problem
29+
attributes:
30+
label: What went wrong
31+
description: Describe the conversion or parse failure as concretely as possible.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: problematic_structure
37+
attributes:
38+
label: Problematic structure
39+
description: For example two-column layout, tables, scanned pages, repeated headers, algorithm images, unusual section numbering.
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: command_or_notes
45+
attributes:
46+
label: Commands run or notes
47+
render: shell
48+
validations:
49+
required: false

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ ruff check src/ tests/
2626
5. New synthetic examples that demonstrate realistic, high-value clinical scenarios.
2727
6. Public-facing docs that make the trust model and limits clearer.
2828

29+
## Where To Open What
30+
31+
- GitHub Discussions: questions, design discussion, workflow ideas, and "would Herald support this?" conversations.
32+
- Bug report issue: reproducible breakage in parsing, querying, conversion, CI, packaging, or docs.
33+
- Feature request issue: concrete proposed change to Herald behavior.
34+
- Guideline-compatibility issue: a real public guideline that currently converts or parses badly and would be a good target for improvement.
35+
- Private vulnerability reporting: anything security-sensitive. See `SECURITY.md`.
36+
2937
## Ground Rules
3038

3139
- Keep runtime querying deterministic.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ Herald is not a bedside autopilot. It is tooling for turning guidelines into ins
9898
- `docs/supported_guidelines.md` - what converts cleanly and what does not
9999
- `SCHEMA.md` - full decision-tree schema
100100
- `CONTRIBUTING.md` - contribution workflow and standards
101+
- `SUPPORT.md` - where to ask questions, report bugs, and discuss ideas
101102

102103
## Install
103104

@@ -279,6 +280,12 @@ To use Herald with a real guideline:
279280

280281
See [CONTRIBUTING.md](CONTRIBUTING.md).
281282

283+
## Discussions And Support
284+
285+
- Use [GitHub Discussions](https://github.com/myceldigital/herald/discussions) for questions, design ideas, and early-stage workflow discussion.
286+
- Use GitHub Issues for concrete bugs, feature requests, and guideline-compatibility requests.
287+
- Use private vulnerability reporting for security-sensitive issues. See [SECURITY.md](SECURITY.md).
288+
282289
## License
283290

284291
MIT

SUPPORT.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Support
2+
3+
## Where To Ask What
4+
5+
### GitHub Discussions
6+
7+
Use [GitHub Discussions](https://github.com/myceldigital/herald/discussions) for:
8+
9+
- setup questions
10+
- workflow questions
11+
- design ideas
12+
- "would Herald support this?" conversations
13+
- early feedback before writing an issue or PR
14+
15+
### GitHub Issues
16+
17+
Use GitHub Issues for:
18+
19+
- reproducible bugs
20+
- concrete feature requests
21+
- guideline-compatibility problems on public guidelines
22+
- documentation fixes
23+
24+
If you can reproduce a problem with a small command sequence or synthetic example, include that up front.
25+
26+
### Security Issues
27+
28+
Do not open public issues for security-sensitive problems.
29+
30+
Use GitHub private vulnerability reporting instead. See [SECURITY.md](SECURITY.md).
31+
32+
## Good Support Requests
33+
34+
The best reports usually include:
35+
36+
- Herald version
37+
- exact command run
38+
- what input you used
39+
- expected result
40+
- actual result
41+
- minimal reproducer if possible
42+
43+
For guideline-compatibility reports, include an official public source URL when possible.

0 commit comments

Comments
 (0)