Skip to content

Commit 0f4c225

Browse files
0x524a0x524a
authored
Merge pull request #5 from 0x524A/github-beautify
feat: add comprehensive documentation and repository metadata
2 parents a6c6ec8 + 18650c3 commit 0f4c225

File tree

11 files changed

+1639
-10
lines changed

11 files changed

+1639
-10
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve metricsd
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## To Reproduce
14+
Steps to reproduce the behavior:
15+
1. Configure metricsd with '...'
16+
2. Run command '...'
17+
3. Observe error '...'
18+
4. See error
19+
20+
## Expected Behavior
21+
<!-- A clear and concise description of what you expected to happen -->
22+
23+
## Actual Behavior
24+
<!-- What actually happened -->
25+
26+
## Environment
27+
<!-- Please complete the following information -->
28+
29+
**metricsd version:**
30+
<!-- Output of: ./metricsd -version -->
31+
32+
**Operating System:**
33+
<!-- e.g., Ubuntu 22.04, CentOS 7, macOS 13, Windows 11 -->
34+
35+
**Architecture:**
36+
<!-- e.g., amd64, arm64 -->
37+
38+
**Go version (if building from source):**
39+
<!-- Output of: go version -->
40+
41+
**Deployment method:**
42+
- [ ] Binary
43+
- [ ] Docker
44+
- [ ] Kubernetes
45+
- [ ] Built from source
46+
47+
**GPU present:**
48+
- [ ] Yes (NVIDIA)
49+
- [ ] No
50+
51+
## Configuration
52+
<!-- Please provide relevant parts of your config.json (sanitize sensitive data) -->
53+
54+
```json
55+
{
56+
"collector": {
57+
...
58+
}
59+
}
60+
```
61+
62+
## Logs
63+
<!-- Please provide relevant log output. Use code blocks for better readability -->
64+
65+
```
66+
[paste logs here]
67+
```
68+
69+
## Additional Context
70+
<!-- Add any other context about the problem here -->
71+
72+
<!-- Screenshots, if applicable -->
73+
74+
## Possible Solution
75+
<!-- Optional: Suggest a fix or reason for the bug -->
76+
77+
## Checklist
78+
- [ ] I have searched existing issues to ensure this is not a duplicate
79+
- [ ] I have provided all requested information
80+
- [ ] I have sanitized any sensitive data from logs and configuration
81+
- [ ] I am using a supported version of metricsd

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for metricsd
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Description
11+
<!-- A clear and concise description of the feature you'd like to see -->
12+
13+
## Problem Statement
14+
<!-- Is your feature request related to a problem? Please describe -->
15+
<!-- e.g., "I'm always frustrated when..." -->
16+
17+
## Proposed Solution
18+
<!-- Describe the solution you'd like -->
19+
20+
## Alternative Solutions
21+
<!-- Describe any alternative solutions or features you've considered -->
22+
23+
## Use Case
24+
<!-- Describe your specific use case and how this feature would help -->
25+
26+
## Example Configuration
27+
<!-- If applicable, show how the feature might be configured -->
28+
29+
```json
30+
{
31+
"new_feature": {
32+
"option": "value"
33+
}
34+
}
35+
```
36+
37+
## Example Usage
38+
<!-- If applicable, show how the feature would be used -->
39+
40+
```bash
41+
# Example commands or API calls
42+
./metricsd --new-feature ...
43+
```
44+
45+
## Benefits
46+
<!-- Who would benefit from this feature? -->
47+
48+
- [ ] Improves existing functionality
49+
- [ ] Adds new metrics collection capability
50+
- [ ] Enhances security
51+
- [ ] Improves performance
52+
- [ ] Better configuration options
53+
- [ ] Improves observability
54+
- [ ] Other: ___
55+
56+
## Implementation Considerations
57+
<!-- Optional: Technical details, potential challenges, or suggestions -->
58+
59+
### Complexity
60+
<!-- How complex do you think this feature is to implement? -->
61+
- [ ] Simple (minor change)
62+
- [ ] Moderate (requires some design work)
63+
- [ ] Complex (significant effort required)
64+
65+
### Breaking Changes
66+
<!-- Would this feature require breaking changes? -->
67+
- [ ] Yes
68+
- [ ] No
69+
- [ ] Unsure
70+
71+
## Additional Context
72+
<!-- Add any other context, screenshots, or examples about the feature request -->
73+
74+
## Related Issues
75+
<!-- Link any related issues or pull requests -->
76+
77+
## Willingness to Contribute
78+
<!-- Are you willing to work on this feature? -->
79+
- [ ] Yes, I can submit a pull request
80+
- [ ] I can help with testing
81+
- [ ] I can provide feedback during development
82+
- [ ] I'm just requesting the feature
83+
84+
## Checklist
85+
- [ ] I have searched existing issues to ensure this hasn't been requested before
86+
- [ ] I have provided a clear description and use case
87+
- [ ] I have considered alternative solutions

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Question
3+
about: Ask a question about metricsd
4+
title: '[QUESTION] '
5+
labels: 'question'
6+
assignees: ''
7+
8+
---
9+
10+
## Question
11+
<!-- Ask your question clearly and concisely -->
12+
13+
## Context
14+
<!-- Provide context that helps us understand your question -->
15+
16+
### What I'm trying to do
17+
<!-- Describe what you're trying to achieve -->
18+
19+
### What I've tried
20+
<!-- List what you've already attempted -->
21+
22+
### Environment (if relevant)
23+
**metricsd version:**
24+
<!-- Output of: ./metricsd -version -->
25+
26+
**Operating System:**
27+
<!-- e.g., Ubuntu 22.04, Docker on Kubernetes -->
28+
29+
**Deployment method:**
30+
- [ ] Binary
31+
- [ ] Docker
32+
- [ ] Kubernetes
33+
34+
## Configuration (if relevant)
35+
<!-- Provide relevant configuration snippets (sanitize sensitive data) -->
36+
37+
```json
38+
{
39+
...
40+
}
41+
```
42+
43+
## Documentation Review
44+
<!-- Have you checked the documentation? -->
45+
- [ ] I have checked the README.md
46+
- [ ] I have checked the configuration examples
47+
- [ ] I have searched existing issues and discussions
48+
- [ ] I could not find an answer to my question
49+
50+
## Additional Context
51+
<!-- Any other information that might help us answer your question -->
52+
53+
## Checklist
54+
- [ ] My question is clear and specific
55+
- [ ] I have provided relevant context
56+
- [ ] This is not a bug report (use the Bug Report template instead)
57+
- [ ] This is not a feature request (use the Feature Request template instead)

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# Pull Request
2+
3+
## Description
4+
<!-- Provide a brief description of your changes -->
5+
6+
## Related Issue
7+
<!-- Link to the related issue(s) -->
8+
Fixes #(issue number)
9+
10+
## Type of Change
11+
<!-- Mark relevant options with an 'x' -->
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
- [ ] Performance improvement
18+
- [ ] Code refactoring
19+
- [ ] Build/CI improvement
20+
- [ ] Other (please describe):
21+
22+
## Changes Made
23+
<!-- Describe the changes in detail -->
24+
25+
### Key changes:
26+
-
27+
-
28+
-
29+
30+
## Testing
31+
<!-- Describe the tests you ran to verify your changes -->
32+
33+
### Test Configuration
34+
**Operating System:**
35+
<!-- e.g., Ubuntu 22.04, macOS 13 -->
36+
37+
**Go version:**
38+
<!-- Output of: go version -->
39+
40+
**GPU present:**
41+
- [ ] Yes (NVIDIA)
42+
- [ ] No
43+
44+
### Tests performed:
45+
- [ ] Unit tests pass (`make test`)
46+
- [ ] Integration tests pass (if applicable)
47+
- [ ] Manual testing performed
48+
- [ ] Tested with Docker
49+
- [ ] Tested with example configurations
50+
51+
### Test cases:
52+
1.
53+
2.
54+
3.
55+
56+
## Configuration Changes
57+
<!-- If your PR introduces configuration changes, provide examples -->
58+
59+
### Before:
60+
```json
61+
{
62+
...
63+
}
64+
```
65+
66+
### After:
67+
```json
68+
{
69+
...
70+
}
71+
```
72+
73+
## Documentation
74+
<!-- Have you updated relevant documentation? -->
75+
76+
- [ ] README.md updated (if needed)
77+
- [ ] Code comments added/updated
78+
- [ ] Configuration examples updated
79+
- [ ] CHANGELOG.md updated (if applicable)
80+
81+
## Breaking Changes
82+
<!-- If this PR introduces breaking changes, describe them and the migration path -->
83+
84+
### What breaks:
85+
<!-- Describe what will break -->
86+
87+
### Migration path:
88+
<!-- Describe how users should migrate -->
89+
90+
## Performance Impact
91+
<!-- Does this change affect performance? -->
92+
93+
- [ ] No performance impact
94+
- [ ] Performance improved
95+
- [ ] Performance may be affected (describe below)
96+
97+
<!-- If performance is affected, provide details -->
98+
99+
## Security Considerations
100+
<!-- Are there any security implications? -->
101+
102+
- [ ] No security implications
103+
- [ ] Security improved
104+
- [ ] Security considerations (describe below)
105+
106+
## Screenshots/Logs
107+
<!-- If applicable, add screenshots or log output to demonstrate the changes -->
108+
109+
```
110+
[paste relevant output here]
111+
```
112+
113+
## Checklist
114+
<!-- Ensure all items are checked before submitting -->
115+
116+
### Code Quality
117+
- [ ] My code follows the project's coding standards
118+
- [ ] I have performed a self-review of my code
119+
- [ ] I have commented my code, particularly in hard-to-understand areas
120+
- [ ] My changes generate no new warnings or errors
121+
- [ ] I have added error handling where appropriate
122+
123+
### Testing
124+
- [ ] I have added tests that prove my fix is effective or my feature works
125+
- [ ] New and existing unit tests pass locally with my changes
126+
- [ ] I have tested the changes manually
127+
128+
### Documentation
129+
- [ ] I have updated relevant documentation
130+
- [ ] I have added/updated code comments
131+
- [ ] I have updated configuration examples if needed
132+
133+
### Git
134+
- [ ] My commits follow the conventional commit format
135+
- [ ] I have rebased my branch on the latest main branch
136+
- [ ] My commit messages are clear and descriptive
137+
138+
### Dependencies
139+
- [ ] I have not introduced new dependencies (or documented why they are necessary)
140+
- [ ] If I added dependencies, I ran `go mod tidy`
141+
142+
## Additional Notes
143+
<!-- Add any additional notes, concerns, or context for reviewers -->
144+
145+
## Reviewers
146+
<!-- Tag relevant reviewers -->
147+
@0x524A
148+
149+
---
150+
151+
**Thank you for contributing to metricsd!** 🚀

0 commit comments

Comments
 (0)