Skip to content

Commit 948d60a

Browse files
committed
dx: add github templates, labeler, stale
1 parent 473b96d commit 948d60a

File tree

8 files changed

+445
-0
lines changed

8 files changed

+445
-0
lines changed
Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in the InferaDB Management API
3+
labels: ["kind/bug", "status/needs-triage"]
4+
body:
5+
- type: checkboxes
6+
id: preflight
7+
attributes:
8+
label: Pre-flight Checklist
9+
options:
10+
- label: I have searched existing issues to ensure this bug hasn't already been reported
11+
required: true
12+
- type: markdown
13+
attributes:
14+
value: |
15+
Thanks for taking the time to report a bug! Please fill out the information below to help us investigate.
16+
17+
- type: dropdown
18+
id: component
19+
attributes:
20+
label: Component
21+
description: Which component is affected?
22+
options:
23+
- Tenancy Management
24+
- Vault Management
25+
- Session/Authentication
26+
- Passkey/WebAuthn
27+
- Client Management
28+
- Team Management
29+
- Permissions
30+
- Audit Logging
31+
- Token Management
32+
- Configuration
33+
- Other
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: description
39+
attributes:
40+
label: Bug Description
41+
description: A clear and concise description of what the bug is.
42+
placeholder: Describe the bug...
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: reproduction
48+
attributes:
49+
label: Steps to Reproduce
50+
description: Steps to reproduce the behavior.
51+
placeholder: |
52+
1. Configure '...'
53+
2. Send request '...'
54+
3. See error
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: expected
60+
attributes:
61+
label: Expected Behavior
62+
description: What did you expect to happen?
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: actual
68+
attributes:
69+
label: Actual Behavior
70+
description: What actually happened?
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: environment
76+
attributes:
77+
label: Environment
78+
description: |
79+
Please provide relevant environment details.
80+
placeholder: |
81+
- InferaDB Management Version: [e.g., 0.1.0]
82+
- OS: [e.g., Ubuntu 22.04, macOS 14]
83+
- Deployment: [e.g., Docker, Kubernetes, Binary]
84+
- Database: [e.g., PostgreSQL, SQLite]
85+
validations:
86+
required: false
87+
88+
- type: textarea
89+
id: logs
90+
attributes:
91+
label: Relevant Logs
92+
description: Please copy and paste any relevant log output.
93+
render: shell
94+
validations:
95+
required: false
96+
97+
- type: textarea
98+
id: additional
99+
attributes:
100+
label: Additional Context
101+
description: Add any other context about the problem here.
102+
validations:
103+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Vulnerability
4+
url: https://github.com/inferadb/inferadb/security/advisories/new
5+
about: Report security vulnerabilities privately
6+
- name: Questions & Support
7+
url: https://github.com/inferadb/inferadb/discussions
8+
about: Ask questions and discuss ideas with the community
9+
- name: Documentation
10+
url: https://inferadb.com/docs
11+
about: Check out our documentation for guides and API references
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Feature Request
2+
description: Suggest a new feature or capability for the InferaDB Management API
3+
labels: ["kind/feature", "status/needs-triage"]
4+
body:
5+
- type: checkboxes
6+
id: preflight
7+
attributes:
8+
label: Pre-flight Checklist
9+
options:
10+
- label: I have searched existing issues and discussions to ensure this hasn't been requested
11+
required: true
12+
13+
- type: markdown
14+
attributes:
15+
value: |
16+
Thanks for suggesting a feature! Please describe your idea in detail.
17+
18+
- type: dropdown
19+
id: component
20+
attributes:
21+
label: Component
22+
description: Which component would this feature affect?
23+
options:
24+
- Tenancy Management
25+
- Vault Management
26+
- Session/Authentication
27+
- Passkey/WebAuthn
28+
- Client Management
29+
- Team Management
30+
- Permissions
31+
- Audit Logging
32+
- Token Management
33+
- Configuration
34+
- Multiple/Cross-cutting
35+
- New component
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: problem
41+
attributes:
42+
label: Problem Statement
43+
description: Is your feature request related to a problem? Please describe.
44+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: solution
50+
attributes:
51+
label: Proposed Solution
52+
description: Describe the solution you'd like.
53+
placeholder: A clear and concise description of what you want to happen.
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: alternatives
59+
attributes:
60+
label: Alternatives Considered
61+
description: Describe any alternative solutions or features you've considered.
62+
validations:
63+
required: false
64+
65+
- type: textarea
66+
id: context
67+
attributes:
68+
label: Additional Context
69+
description: Add any other context, mockups, or examples about the feature request here.
70+
validations:
71+
required: false
72+
73+
- type: dropdown
74+
id: contribution
75+
attributes:
76+
label: Would you be willing to contribute this feature?
77+
options:
78+
- "Yes, I'd like to implement this"
79+
- "Yes, with guidance"
80+
- "No, but I can help test"
81+
- "No"
82+
validations:
83+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Pull Request
2+
3+
## Summary
4+
5+
<!-- What does this PR do? Keep it brief (1-3 sentences) -->
6+
7+
## Related Issues
8+
9+
<!-- Link related issues: Fixes #123, Closes #456, Relates to #789 -->
10+
11+
## Changes
12+
13+
<!-- What changed? Bullet points work well -->
14+
15+
-
16+
17+
## Testing
18+
19+
<!-- How was this tested? Check all that apply -->
20+
21+
- [ ] Unit tests added/updated
22+
- [ ] Integration tests added/updated
23+
- [ ] Manual testing performed
24+
25+
## Checklist
26+
27+
- [ ] Tests pass locally (`cargo test`)
28+
- [ ] Code quality checks pass (`cargo clippy`)
29+
- [ ] Documentation updated (if applicable)
30+
- [ ] No breaking changes (or clearly documented)

.github/dependabot.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ updates:
1111
time: "09:00"
1212
timezone: "Etc/UTC"
1313
open-pull-requests-limit: 5
14+
labels:
15+
- "dependencies"
16+
- "area/deps"
1417
commit-message:
1518
prefix: "deps"
1619
include: "scope"
@@ -45,6 +48,10 @@ updates:
4548
time: "09:00"
4649
timezone: "Etc/UTC"
4750
open-pull-requests-limit: 5
51+
labels:
52+
- "dependencies"
53+
- "github-actions"
54+
- "area/ci"
4855
commit-message:
4956
prefix: "ci"
5057
include: "scope"
@@ -63,6 +70,9 @@ updates:
6370
time: "09:00"
6471
timezone: "Etc/UTC"
6572
open-pull-requests-limit: 3
73+
labels:
74+
- "dependencies"
75+
- "area/docker"
6676
commit-message:
6777
prefix: "docker"
6878
groups:
@@ -74,3 +84,7 @@ updates:
7484
directory: /docker/fdb-integration-tests
7585
schedule:
7686
interval: daily
87+
labels:
88+
- "dependencies"
89+
- "area/docker"
90+
- "area/testing"

.github/labeler.yml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
# Documentation
2+
area/docs:
3+
- changed-files:
4+
- any-glob-to-any-file:
5+
- "**/*.md"
6+
- "docs/**/*"
7+
8+
# CI/CD
9+
area/ci:
10+
- changed-files:
11+
- any-glob-to-any-file:
12+
- ".github/**/*"
13+
14+
# Docker
15+
area/docker:
16+
- changed-files:
17+
- any-glob-to-any-file:
18+
- "**/Dockerfile*"
19+
- "**/.dockerignore"
20+
- "**/docker-compose*.yml"
21+
- "**/docker-compose*.yaml"
22+
23+
# Configuration
24+
area/config:
25+
- changed-files:
26+
- any-glob-to-any-file:
27+
- "**/*.toml"
28+
- "**/*.yaml"
29+
- "**/*.yml"
30+
- "**/*.json"
31+
- "!package*.json"
32+
- "!.github/**/*"
33+
34+
# Dependencies
35+
area/deps:
36+
- changed-files:
37+
- any-glob-to-any-file:
38+
- "**/Cargo.toml"
39+
- "**/Cargo.lock"
40+
41+
# Testing
42+
area/testing:
43+
- changed-files:
44+
- any-glob-to-any-file:
45+
- "**/tests/**/*"
46+
- "**/*_test.rs"
47+
- "**/*_tests.rs"
48+
49+
# Tenancy/Multi-tenant
50+
area/tenancy:
51+
- changed-files:
52+
- any-glob-to-any-file:
53+
- "**/tenant/**/*"
54+
- "**/tenancy/**/*"
55+
- "**/multi-tenant/**/*"
56+
57+
# Vault Management
58+
area/vault:
59+
- changed-files:
60+
- any-glob-to-any-file:
61+
- "**/vault/**/*"
62+
63+
# Session/Authentication
64+
area/session:
65+
- changed-files:
66+
- any-glob-to-any-file:
67+
- "**/session/**/*"
68+
- "**/auth/**/*"
69+
- "**/authentication/**/*"
70+
71+
# Passkey/WebAuthn
72+
area/passkey:
73+
- changed-files:
74+
- any-glob-to-any-file:
75+
- "**/passkey/**/*"
76+
- "**/webauthn/**/*"
77+
78+
# Client Management
79+
area/client:
80+
- changed-files:
81+
- any-glob-to-any-file:
82+
- "**/client/**/*"
83+
84+
# Team Management
85+
area/team:
86+
- changed-files:
87+
- any-glob-to-any-file:
88+
- "**/team/**/*"
89+
90+
# RBAC/Permissions
91+
area/rbac:
92+
- changed-files:
93+
- any-glob-to-any-file:
94+
- "**/rbac/**/*"
95+
- "**/permissions/**/*"
96+
- "**/roles/**/*"
97+
98+
# Audit Logging
99+
area/audit:
100+
- changed-files:
101+
- any-glob-to-any-file:
102+
- "**/audit/**/*"
103+
104+
# Token Management
105+
area/token:
106+
- changed-files:
107+
- any-glob-to-any-file:
108+
- "**/token/**/*"
109+
- "**/jwt/**/*"
110+
111+
# Observability
112+
area/observability:
113+
- changed-files:
114+
- any-glob-to-any-file:
115+
- "**/telemetry/**/*"
116+
- "**/metrics/**/*"
117+
- "**/tracing/**/*"
118+
- "**/logging/**/*"
119+
120+
# Repository label
121+
repo/management:
122+
- changed-files:
123+
- any-glob-to-any-file:
124+
- "**/*"

0 commit comments

Comments
 (0)