Skip to content

Commit 9c7a4db

Browse files
author
Flamehaven Labs
committed
Add GitHub repository metadata guide
1 parent b53fd66 commit 9c7a4db

1 file changed

Lines changed: 251 additions & 0 deletions

File tree

GITHUB_METADATA.md

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
# GitHub Repository Metadata
2+
3+
## About (Description)
4+
5+
Production-grade static analyzer for detecting AI-generated code quality issues: empty functions, buzzword inflation, and overhyped comments. 79% test coverage, 34 tests passing.
6+
7+
## Topics (GitHub Tags)
8+
9+
```
10+
ai
11+
artificial-intelligence
12+
code-quality
13+
static-analysis
14+
code-analyzer
15+
linter
16+
python
17+
ai-detection
18+
code-review
19+
developer-tools
20+
testing
21+
quality-assurance
22+
slop-detection
23+
llm
24+
code-generator
25+
ast-analysis
26+
metrics
27+
technical-debt
28+
continuous-integration
29+
python3
30+
```
31+
32+
## Suggested Topics (Prioritized - Max 20)
33+
34+
**Primary (Core functionality):**
35+
1. `ai-code-quality`
36+
2. `static-analysis`
37+
3. `code-analyzer`
38+
4. `ai-detection`
39+
5. `slop-detector`
40+
41+
**Secondary (Technology):**
42+
6. `python`
43+
7. `python3`
44+
8. `ast-analysis`
45+
9. `code-metrics`
46+
47+
**Tertiary (Use cases):**
48+
10. `code-review`
49+
11. `code-quality`
50+
12. `linter`
51+
13. `quality-assurance`
52+
14. `testing`
53+
54+
**Additional (Context):**
55+
15. `llm`
56+
16. `ai-generated-code`
57+
17. `developer-tools`
58+
18. `continuous-integration`
59+
19. `technical-debt`
60+
20. `software-quality`
61+
62+
## One-liner Description Options
63+
64+
**Option 1 (Current - Comprehensive):**
65+
```
66+
Production-grade static analyzer for detecting AI-generated code quality issues: empty functions, buzzword inflation, and overhyped comments. 79% test coverage, 34 tests passing.
67+
```
68+
69+
**Option 2 (Concise):**
70+
```
71+
Detect AI-generated code slop: empty functions, buzzword inflation, overhyped comments. Production-ready with 79% coverage.
72+
```
73+
74+
**Option 3 (Feature-focused):**
75+
```
76+
Static analyzer detecting 3 AI code anti-patterns: empty implementations, documentation inflation, and comment hype. 34 tests, 79% coverage.
77+
```
78+
79+
**Option 4 (Problem-focused):**
80+
```
81+
Stop shipping AI slop. Detects empty functions, fake documentation, and inflated comments in AI-generated code. Production-ready.
82+
```
83+
84+
**Option 5 (Technical):**
85+
```
86+
Multi-metric static analyzer (LDR, Inflation, DDC) for AI-generated code quality. Pattern registry with 12+ anti-patterns. Python 3.8+
87+
```
88+
89+
## Repository Website
90+
91+
```
92+
https://github.com/flamehaven01/AI-SLOP-Detector
93+
```
94+
95+
## Social Preview Card Text
96+
97+
**Title:** AI-SLOP Detector v2.5.0
98+
99+
**Description:**
100+
Production-grade static analyzer for AI-generated code quality. Detects empty functions, buzzword inflation, and overhyped comments.
101+
102+
**Stats:**
103+
- ✅ 34/34 tests passing
104+
- 📊 79% coverage
105+
- 🎯 A-Tier (88/100)
106+
- 🚀 Production Ready
107+
108+
---
109+
110+
## How to Update on GitHub
111+
112+
### Via GitHub Web Interface:
113+
114+
1. **About Section:**
115+
- Go to repository main page
116+
- Click ⚙️ (gear icon) next to "About"
117+
- Add description (choose from options above)
118+
- Add website URL (optional)
119+
- Add topics (paste from list below)
120+
121+
2. **Topics (Copy-paste ready):**
122+
```
123+
ai-code-quality, static-analysis, code-analyzer, ai-detection, slop-detector, python, python3, ast-analysis, code-metrics, code-review, code-quality, linter, quality-assurance, testing, llm, ai-generated-code, developer-tools, continuous-integration, technical-debt, software-quality
124+
```
125+
126+
### Via GitHub CLI:
127+
128+
```bash
129+
# Update repository description
130+
gh repo edit flamehaven01/AI-SLOP-Detector \
131+
--description "Production-grade static analyzer for detecting AI-generated code quality issues: empty functions, buzzword inflation, and overhyped comments. 79% test coverage, 34 tests passing."
132+
133+
# Add topics (requires API call)
134+
gh api repos/flamehaven01/AI-SLOP-Detector/topics \
135+
-X PUT \
136+
-f names='["ai-code-quality","static-analysis","code-analyzer","ai-detection","slop-detector","python","python3","ast-analysis","code-metrics","code-review","code-quality","linter","quality-assurance","testing","llm","ai-generated-code","developer-tools","continuous-integration","technical-debt","software-quality"]'
137+
```
138+
139+
### Via Git Repository Settings File:
140+
141+
Create `.github/settings.yml` (if using Probot):
142+
143+
```yaml
144+
repository:
145+
name: AI-SLOP-Detector
146+
description: Production-grade static analyzer for detecting AI-generated code quality issues
147+
homepage: https://ai-slop-detector.readthedocs.io
148+
topics:
149+
- ai-code-quality
150+
- static-analysis
151+
- code-analyzer
152+
- ai-detection
153+
- slop-detector
154+
- python
155+
- python3
156+
- ast-analysis
157+
- code-metrics
158+
- code-review
159+
- code-quality
160+
- linter
161+
- quality-assurance
162+
- testing
163+
- llm
164+
- ai-generated-code
165+
- developer-tools
166+
- continuous-integration
167+
- technical-debt
168+
- software-quality
169+
private: false
170+
has_issues: true
171+
has_projects: true
172+
has_wiki: false
173+
has_downloads: true
174+
default_branch: main
175+
allow_squash_merge: true
176+
allow_merge_commit: true
177+
allow_rebase_merge: true
178+
```
179+
180+
---
181+
182+
## Recommended Configuration
183+
184+
**Best Description (Balanced):**
185+
```
186+
Production-grade static analyzer for detecting AI-generated code quality issues: empty functions, buzzword inflation, and overhyped comments. 79% test coverage, 34 tests passing.
187+
```
188+
189+
**Best Topics (20 tags):**
190+
```
191+
ai-code-quality
192+
static-analysis
193+
code-analyzer
194+
ai-detection
195+
slop-detector
196+
python
197+
python3
198+
ast-analysis
199+
code-metrics
200+
code-review
201+
code-quality
202+
linter
203+
quality-assurance
204+
testing
205+
llm
206+
ai-generated-code
207+
developer-tools
208+
continuous-integration
209+
technical-debt
210+
software-quality
211+
```
212+
213+
**Homepage URL:**
214+
```
215+
https://github.com/flamehaven01/AI-SLOP-Detector
216+
```
217+
(Or documentation URL if available)
218+
219+
---
220+
221+
## SEO Keywords for Discovery
222+
223+
**Primary Keywords:**
224+
- AI code quality
225+
- AI slop detector
226+
- AI-generated code analyzer
227+
- Static code analysis
228+
- Code quality metrics
229+
230+
**Secondary Keywords:**
231+
- Empty function detection
232+
- Buzzword inflation detector
233+
- Code comment analyzer
234+
- LLM code quality
235+
- Python code analyzer
236+
237+
**Long-tail Keywords:**
238+
- Detect AI-generated code issues
239+
- Analyze AI code quality Python
240+
- Static analyzer for LLM code
241+
- Find empty functions in code
242+
- Detect fake documentation
243+
244+
---
245+
246+
## Social Media Hashtags
247+
248+
```
249+
#AICode #CodeQuality #StaticAnalysis #Python #DevTools
250+
#AI #MachineLearning #SoftwareQuality #CodeReview #Testing
251+
```

0 commit comments

Comments
 (0)