Skip to content

Commit 7a25166

Browse files
BittuBarnwal7479BittuBarnwal7479
authored
Add organization community templates (#4)
1 parent dfa63cd commit 7a25166

6 files changed

Lines changed: 253 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report
2+
description: Report a bug, regression, or unexpected behavior.
3+
title: "[Bug]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping improve Hex. Please include enough detail for maintainers to reproduce the issue.
9+
- type: dropdown
10+
id: component
11+
attributes:
12+
label: Product or component
13+
description: Where did the issue occur? This helps us route reports filed in the wrong repository.
14+
options:
15+
- Hex.pm website or API
16+
- Hex CLI
17+
- HexDocs hosting, rendering, or search
18+
- Package preview
19+
- Version diff
20+
- Bob or package builds
21+
- Infrastructure
22+
- Other
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: summary
27+
attributes:
28+
label: Summary
29+
description: Describe the bug clearly and briefly.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: actual-behavior
34+
attributes:
35+
label: What happened?
36+
description: Tell us what you observed.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: expected-behavior
41+
attributes:
42+
label: What did you expect?
43+
description: Describe the expected behavior.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: reproduction
48+
attributes:
49+
label: Steps to reproduce
50+
description: List the exact steps needed to reproduce the issue.
51+
placeholder: |
52+
1.
53+
2.
54+
3.
55+
validations:
56+
required: true
57+
- type: markdown
58+
attributes:
59+
value: |
60+
Please redact private data before posting. Do not include API keys, session tokens, email addresses, billing details, or other sensitive account information.
61+
- type: textarea
62+
id: environment
63+
attributes:
64+
label: Environment / context
65+
description: Share the relevant package, organization, account, browser, OS, API client, or permissions context.
66+
placeholder: |
67+
Package:
68+
Organization:
69+
API endpoint or client:
70+
Browser:
71+
OS:
72+
Recent permission or account changes:
73+
- type: textarea
74+
id: logs
75+
attributes:
76+
label: Logs / screenshots
77+
description: Paste logs, error messages, screenshots, or relevant run output here.
78+
- type: textarea
79+
id: additional-context
80+
attributes:
81+
label: Additional context
82+
description: Add anything else that may help reproduce the issue.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Report a security vulnerability
5+
url: https://github.com/hexpm/.github/security/policy
6+
about: Use private vulnerability reporting or email as described in the organization security policy.
7+
- name: Hex documentation
8+
url: https://hex.pm/docs
9+
about: Read the documentation before opening an issue.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Documentation
2+
description: Report unclear, missing, or outdated Hex documentation.
3+
title: "[Docs]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Most package documentation on HexDocs is written and maintained by the package owner. For corrections to package-authored content, please open an issue in the package's source repository instead.
9+
- type: dropdown
10+
id: documentation-type
11+
attributes:
12+
label: Documentation type
13+
description: Which documentation is affected?
14+
options:
15+
- Hex.pm documentation
16+
- HexDocs hosting, rendering, or search
17+
- Package-authored content (report this to the package repository)
18+
- Other
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: page-section
23+
attributes:
24+
label: Page / section
25+
description: Which documentation page or section is affected?
26+
placeholder: https://hex.pm/docs/...
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: issue
31+
attributes:
32+
label: What is unclear or missing?
33+
description: Describe the issue with the documentation.
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: suggested-improvement
38+
attributes:
39+
label: Suggested improvement
40+
description: What would make this easier to understand?
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional context
47+
description: Add links, screenshots, or examples if helpful.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Feature Request
2+
description: Suggest a new capability or improvement.
3+
title: "[Feature]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for suggesting an improvement. Please focus on the workflow or user problem first.
9+
- type: dropdown
10+
id: component
11+
attributes:
12+
label: Product or component
13+
description: Which product or component would this improve?
14+
options:
15+
- Hex.pm website or API
16+
- Hex CLI
17+
- HexDocs hosting, rendering, or search
18+
- Package preview
19+
- Version diff
20+
- Bob or package builds
21+
- Infrastructure
22+
- Other
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: problem
27+
attributes:
28+
label: Problem statement
29+
description: What problem are you trying to solve?
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: proposed-solution
34+
attributes:
35+
label: Proposed solution
36+
description: Describe the solution you would like to see.
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: usefulness
41+
attributes:
42+
label: Why is this useful?
43+
description: Explain the benefit to Hex users or maintainers.
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: alternatives
48+
attributes:
49+
label: Alternatives considered
50+
description: List any other approaches you considered.
51+
- type: textarea
52+
id: additional-context
53+
attributes:
54+
label: Additional context
55+
description: Add examples, references, implementation ideas, or screenshots.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Question
2+
description: Ask a question about using Hex.
3+
title: "[Question]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
For usage help, please check the Hex documentation first: https://hex.pm/docs
9+
- type: dropdown
10+
id: component
11+
attributes:
12+
label: Product or component
13+
description: What is your question about?
14+
options:
15+
- Hex.pm website or API
16+
- Hex CLI
17+
- HexDocs hosting, rendering, or search
18+
- Package preview
19+
- Version diff
20+
- Bob or package builds
21+
- Infrastructure
22+
- Other
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: question
27+
attributes:
28+
label: Question
29+
description: What would you like to know?
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: context
34+
attributes:
35+
label: Context
36+
description: What are you trying to do?
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: attempted
41+
attributes:
42+
label: What have you tried?
43+
description: Share any steps you already attempted.
44+
- type: textarea
45+
id: relevant-details
46+
attributes:
47+
label: Relevant details
48+
description: Share relevant package, organization, API client, logs, or screenshots. This question is public, so redact secrets, tokens, account identifiers, and other sensitive data.
49+
- type: textarea
50+
id: additional-context
51+
attributes:
52+
label: Additional context
53+
description: Anything else that would help answer the question.

‎.github/pull_request_template.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Summary
2+
3+
<!-- Briefly describe the change and the problem it solves. -->
4+
5+
## Testing
6+
7+
<!-- List the checks you ran, or explain why testing was not needed. -->

0 commit comments

Comments
 (0)