Skip to content

Commit 39139ed

Browse files
jesseouejesseoue
committed
feat: enhance repository with professional developer experience
✨ Added professional repository features: - MIT License for open source compliance - Comprehensive CONTRIBUTING.md with development guidelines - GitHub issue templates (bug reports, feature requests, documentation) - GitHub Actions workflow for automated OpenAPI validation - CHANGELOG.md for tracking specification updates - SECURITY.md with security best practices and disclosure policy - Dependabot configuration for automated security updates 🛠️ Developer experience improvements: - Structured issue reporting with proper templates - Automated validation on every PR - Security scanning and dependency management - Clear contribution guidelines with testing requirements - Professional documentation standards 🔐 Security enhancements: - Environment variable best practices - No hardcoded credentials policy - Automated secret scanning - Vulnerability disclosure process This makes the repository production-ready for community contributions while maintaining high standards for API specification accuracy.
1 parent 4bde5c5 commit 39139ed

9 files changed

Lines changed: 894 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: 🐛 API Discrepancy Report
2+
description: Report when the OpenAPI specification doesn't match the actual API behavior
3+
title: "[BUG] "
4+
labels: ["bug", "api-discrepancy"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve the LeadMagic OpenAPI specification!
10+
Please provide as much detail as possible to help us fix the issue.
11+
12+
- type: dropdown
13+
id: endpoint
14+
attributes:
15+
label: Affected Endpoint
16+
description: Which API endpoint has the discrepancy?
17+
options:
18+
- /credits
19+
- /email-validate
20+
- /email-finder
21+
- /mobile-finder
22+
- /personal-email-finder
23+
- /b2b-social-email
24+
- /b2b-profile
25+
- /profile-search
26+
- /role-finder
27+
- /employee-finder
28+
- /company-search
29+
- /company-funding
30+
- /jobs-finder
31+
- /job-country
32+
- /job-types
33+
- /google/searchads
34+
- /meta/searchads
35+
- /b2b/searchads
36+
- /b2b/ad-details
37+
- Other/Multiple
38+
validations:
39+
required: true
40+
41+
- type: dropdown
42+
id: discrepancy-type
43+
attributes:
44+
label: Type of Discrepancy
45+
description: What kind of issue did you find?
46+
options:
47+
- Response field missing from spec
48+
- Response field in spec but not in API
49+
- Wrong field type in spec
50+
- Wrong field name in spec
51+
- Wrong HTTP status code
52+
- Wrong request parameter
53+
- Credit cost mismatch
54+
- Other
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: current-spec
60+
attributes:
61+
label: Current Specification
62+
description: What does our OpenAPI specification currently say?
63+
placeholder: Copy the relevant part from the YAML/JSON spec
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: actual-api
69+
attributes:
70+
label: Actual API Response
71+
description: What does the actual API return?
72+
placeholder: Paste the actual JSON response from the API
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: reproduce
78+
attributes:
79+
label: How to Reproduce
80+
description: Steps to reproduce the discrepancy
81+
placeholder: |
82+
1. Make API call to ...
83+
2. With parameters ...
84+
3. Observe response ...
85+
validations:
86+
required: true
87+
88+
- type: textarea
89+
id: additional-context
90+
attributes:
91+
label: Additional Context
92+
description: Any other context about the problem
93+
placeholder: Screenshots, additional examples, related issues, etc.
94+
95+
- type: checkboxes
96+
id: terms
97+
attributes:
98+
label: Verification
99+
description: Please confirm the following
100+
options:
101+
- label: I tested this against the live LeadMagic API
102+
required: true
103+
- label: I have a valid API key and sufficient credits
104+
required: true
105+
- label: I checked that this isn't already reported
106+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: 📚 Documentation Issue
2+
description: Report problems with documentation, examples, or guides
3+
title: "[DOCS] "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation!
10+
Clear and accurate documentation is crucial for a great developer experience.
11+
12+
- type: dropdown
13+
id: doc-type
14+
attributes:
15+
label: Documentation Type
16+
description: What type of documentation issue is this?
17+
options:
18+
- README.md
19+
- OpenAPI specification
20+
- Code examples
21+
- Contributing guide
22+
- API response examples
23+
- Use case documentation
24+
- Installation/setup guide
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: issue-type
31+
attributes:
32+
label: Issue Type
33+
description: What kind of documentation issue?
34+
options:
35+
- Typo/grammar error
36+
- Unclear explanation
37+
- Missing information
38+
- Incorrect information
39+
- Broken link
40+
- Outdated content
41+
- Missing example
42+
- Confusing example
43+
- Other
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: location
49+
attributes:
50+
label: Location
51+
description: Where is the documentation issue?
52+
placeholder: |
53+
File: README.md
54+
Section: Email Validation
55+
Line: 125
56+
Or provide a URL if applicable
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: current-content
62+
attributes:
63+
label: Current Content
64+
description: What does the documentation currently say?
65+
placeholder: Copy the problematic text here
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: suggested-improvement
71+
attributes:
72+
label: Suggested Improvement
73+
description: How should it be fixed or improved?
74+
placeholder: Provide the corrected text or describe the improvement
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
id: additional-context
80+
attributes:
81+
label: Additional Context
82+
description: Any other relevant information
83+
placeholder: Why is this confusing? How did you encounter this issue? Screenshots?

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: ✨ Feature Request
2+
description: Suggest improvements to the OpenAPI specification or documentation
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting improvements to the LeadMagic OpenAPI specification!
10+
Your ideas help make this resource better for all developers.
11+
12+
- type: dropdown
13+
id: feature-type
14+
attributes:
15+
label: Feature Type
16+
description: What type of improvement are you suggesting?
17+
options:
18+
- New endpoint documentation
19+
- Better examples
20+
- Additional use cases
21+
- Developer tools/utilities
22+
- Documentation improvements
23+
- Code generation improvements
24+
- Testing enhancements
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: problem
31+
attributes:
32+
label: Problem Description
33+
description: What problem does this feature solve?
34+
placeholder: Describe the current limitation or pain point
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: solution
40+
attributes:
41+
label: Proposed Solution
42+
description: What would you like to see added or changed?
43+
placeholder: Describe your proposed solution in detail
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Alternative Solutions
51+
description: Have you considered any alternative approaches?
52+
placeholder: Describe any alternative solutions you've considered
53+
54+
- type: textarea
55+
id: use-case
56+
attributes:
57+
label: Use Case
58+
description: How would this feature be used?
59+
placeholder: Provide a concrete example of how this would be beneficial
60+
61+
- type: dropdown
62+
id: priority
63+
attributes:
64+
label: Priority
65+
description: How important is this feature to you?
66+
options:
67+
- Low - Nice to have
68+
- Medium - Would be helpful
69+
- High - Important for my work
70+
- Critical - Blocking my work
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: additional-context
76+
attributes:
77+
label: Additional Context
78+
description: Any other context, screenshots, or examples
79+
placeholder: Links to relevant documentation, examples from other APIs, etc.

‎.github/dependabot.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
version: 2
2+
updates:
3+
# Monitor GitHub Actions for security updates
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
open-pull-requests-limit: 5
10+
labels:
11+
- "dependencies"
12+
- "github-actions"
13+
commit-message:
14+
prefix: "ci"
15+
include: "scope"
16+
17+
# Monitor npm dependencies (if we add package.json in future)
18+
- package-ecosystem: "npm"
19+
directory: "/"
20+
schedule:
21+
interval: "weekly"
22+
day: "monday"
23+
open-pull-requests-limit: 5
24+
labels:
25+
- "dependencies"
26+
- "npm"
27+
commit-message:
28+
prefix: "deps"
29+
include: "scope"
30+
# Only security updates for now since we don't have package.json yet
31+
allow:
32+
- dependency-type: "all"
33+
ignore:
34+
# Ignore patch updates unless they're security-related
35+
- dependency-name: "*"
36+
update-types: ["version-update:semver-patch"]
37+
versioning-strategy: "increase"

0 commit comments

Comments
 (0)