Skip to content

Commit f831920

Browse files
authored
Merge pull request #14 from adhocteam/add-issue-template
Add issue templates
2 parents ad2084c + 5f6289a commit f831920

File tree

3 files changed

+80
-1
lines changed

3 files changed

+80
-1
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve usai-api
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
A clear and concise description of what the bug is.
11+
12+
## To Reproduce
13+
Steps to reproduce the behavior:
14+
1. API call made: '...'
15+
2. Parameters used: '...'
16+
3. Error occurred: '...'
17+
18+
## Expected behavior
19+
A clear and concise description of what you expected to happen.
20+
21+
## Code snippet
22+
```javascript
23+
// Please provide a minimal code example that reproduces the issue
24+
```
25+
26+
## Error details
27+
28+
- Error message:
29+
- HTTP status code (if applicable):
30+
- Stack trace (if available):
31+
32+
## Environment
33+
34+
- usai-api version: [e.g. 0.1.0]
35+
- Node.js version: [e.g. 18.17.0]
36+
- Operating System: [e.g. Ubuntu 20.04, Windows 11, macOS 13]
37+
- Agency/Organization: [if comfortable sharing]
38+
39+
## Model and endpoint
40+
41+
- Model used: [e.g. claude_3_5_sonnet, gemini-2.0-flash]
42+
- Endpoint: [e.g. chat/completions, embeddings, models]
43+
44+
## Additional context
45+
Add any other context about the problem here. Please redact any sensitive information including API keys or agency-specific URLs.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for usai-api
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Is your feature request related to a problem?
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Describe the solution you'd like
13+
A clear and concise description of what you want to happen.
14+
15+
## Describe alternatives you've considered
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## Use case
19+
Describe how this feature would benefit government agencies or developers using the USAi.gov API.
20+
21+
## Proposed API
22+
If applicable, show what the new API might look like:
23+
```javascript
24+
// Example of proposed usage
25+
```
26+
27+
## Additional context
28+
Add any other context, screenshots, or examples about the feature request here.
29+
30+
### Priority
31+
32+
- [ ] Nice to have
33+
- [ ] Important for my use case
34+
- [ ] Critical/blocking issue

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ <h3>Security</h3>
244244
<h3>Issues</h3>
245245
<p>Bug reports and feature requests</p>
246246
</a>
247-
<a href="https://github.com/adhocteam/usai-api/issues" class="resource-card">
247+
<a href="https://github.com/adhocteam/usai-api/discussions" class="resource-card">
248248
<span class="icon">💬</span>
249249
<h3>Discussions</h3>
250250
<p>Community questions and ideas</p>

0 commit comments

Comments
 (0)