Skip to content

Commit 660fae2

Browse files
asdekasdek
committed
initial state
0 parents  commit 660fae2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+20286
-0
lines changed

‎.github/ISSUE_TEMPLATE/1-bug-report.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: "\U0001F41B Bug report"
2+
description: "Report a bug in VXControl Cloud SDK"
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees:
6+
- asdek
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report! Please provide as much information as possible to help us diagnose and fix the SDK issue.
12+
- type: dropdown
13+
id: component
14+
attributes:
15+
label: Affected Component
16+
description: Which component of VXControl Cloud SDK is affected by this bug?
17+
multiple: true
18+
options:
19+
- SDK Core (Call patterns, Transport, Configuration)
20+
- Security Framework (PoW, Encryption, Signatures)
21+
- Data Models (Request/Response types, Validation)
22+
- Anonymizer Engine (PII/Secrets masking, Pattern recognition)
23+
- License System (Validation, Introspection, Tier management)
24+
- Examples (Integration patterns, Usage demonstrations)
25+
- Documentation (README, API reference, Package docs)
26+
- Other (please specify in the description)
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Describe the bug
32+
description: Please provide a clear and concise description of the bug, including expected and actual behavior.
33+
placeholder: |
34+
What happened:
35+
- Actual behavior: When using SDK function [function_name], the API call [behavior]
36+
37+
What should happen:
38+
- Expected behavior: The SDK should [expected outcome]
39+
40+
Additional context:
41+
- Target service: [Update/Package/Support/AI Investigation]
42+
- Error messages: [any error messages from SDK or cloud services]
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Steps to Reproduce
48+
description: Please provide detailed steps to reproduce the bug.
49+
placeholder: |
50+
1. Initialize SDK with configuration: [provide CallConfig details]
51+
2. Call SDK function: [specific function call with parameters]
52+
3. Observe behavior: [what happens vs what should happen]
53+
4. Error occurs when: [specific conditions or inputs]
54+
5. Minimal code example: [provide minimal reproducible example]
55+
validations:
56+
required: true
57+
- type: textarea
58+
attributes:
59+
label: System Configuration
60+
description: Please provide details about your setup
61+
placeholder: |
62+
SDK Version: [e.g., latest from GitHub releases]
63+
Integration Type:
64+
- [ ] Update Service Integration
65+
- [ ] Package Management Integration
66+
- [ ] Support Service Integration
67+
- [ ] AI Investigation Integration
68+
69+
Environment:
70+
- Go Version: [output of `go version`]
71+
- Host OS: [e.g., Ubuntu 22.04, macOS 14.0, Windows 11]
72+
- Target Architecture: [amd64/arm64]
73+
74+
License Configuration:
75+
- [ ] No License (Free tier)
76+
- [ ] Professional License
77+
- [ ] Enterprise License
78+
79+
SDK Configuration:
80+
- Host: [e.g., update.pentagi.com, support.pentagi.com]
81+
- Methods: [CallMethodPOST/GET/etc]
82+
- Call Types: [CallReqBytesRespBytes/etc]
83+
validations:
84+
required: true
85+
- type: textarea
86+
attributes:
87+
label: Logs and Artifacts
88+
description: |
89+
Please provide relevant logs and error information:
90+
- SDK error messages and stack traces
91+
- Go application logs with SDK debug information
92+
- Network errors or connection issues
93+
- PoW solving timeouts or failures
94+
placeholder: |
95+
```
96+
Paste error messages and relevant logs here
97+
```
98+
99+
For large logs or full stack traces, please use GitHub Gist and provide the link.
100+
validations:
101+
required: false
102+
- type: textarea
103+
attributes:
104+
label: Screenshots or Recordings
105+
description: |
106+
If applicable, add screenshots or recordings to help explain your problem.
107+
- For integration issues: Code screenshots showing the problem
108+
- For error dialogs: Screenshots of error messages
109+
- For network issues: Terminal output or debug logs
110+
placeholder: Drag and drop images here, or paste links to external storage.
111+
validations:
112+
required: false
113+
- type: checkboxes
114+
id: verification
115+
attributes:
116+
label: Verification
117+
description: Please verify the following before submitting
118+
options:
119+
- label: I have checked that this issue hasn't been already reported
120+
- label: I have provided SDK configuration details (with sensitive data removed)
121+
- label: I have included relevant error messages and stack traces
122+
- label: I am using a supported Go version (1.24.0+)
123+
- label: I have tested with the latest SDK version
124+
validations:
125+
required: true

‎.github/ISSUE_TEMPLATE/2-enhancement.yml‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: "\U0001F680 Enhancement"
2+
description: "Suggest an enhancement for VXControl Cloud SDK"
3+
title: "[Enhancement]: "
4+
labels: ["enhancement"]
5+
assignees:
6+
- asdek
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for suggesting an enhancement to make VXControl Cloud SDK better! Please provide as much detail as possible to help us understand your suggestion.
12+
- type: dropdown
13+
id: component
14+
attributes:
15+
label: Target Component
16+
description: Which component of VXControl Cloud SDK would this enhancement affect?
17+
multiple: true
18+
options:
19+
- SDK Core (Call patterns, Transport, Configuration)
20+
- Security Framework (PoW, Encryption, Signatures)
21+
- Data Models (Request/Response types, Validation)
22+
- Anonymizer Engine (PII/Secrets masking, Pattern recognition)
23+
- License System (Validation, Introspection, Tier management)
24+
- Examples (Integration patterns, Usage demonstrations)
25+
- Documentation (README, API reference, Package docs)
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Enhancement Description
31+
description: Please describe the enhancement you would like to see.
32+
placeholder: |
33+
Problem Statement:
34+
- Current Limitation: [describe what's currently missing from SDK or could be improved]
35+
- Use Case: [describe how you use VXControl Cloud SDK and why this enhancement would help]
36+
37+
Proposed Solution:
38+
- Feature Description: [detailed description of the SDK enhancement]
39+
- Expected Benefits: [how this would improve SDK integration and developer experience]
40+
41+
Example Scenario:
42+
[Provide a concrete code example of how this enhancement would be used in security tool integration]
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Technical Details
48+
description: If you have technical suggestions for implementation, please share them.
49+
placeholder: |
50+
Implementation Approach:
51+
- SDK Changes: [changes needed to current SDK architecture]
52+
- New Function Types: [any new call patterns needed]
53+
- Dependencies: [new Go modules or libraries required]
54+
55+
Integration Points:
56+
- Call Patterns: [how it affects existing function types]
57+
- Data Models: [new request/response models needed]
58+
- Security Framework: [PoW, encryption, or signature changes]
59+
- Anonymization: [any new pattern recognition requirements]
60+
61+
Security Considerations:
62+
- [Any cryptographic or anonymization implications to consider]
63+
validations:
64+
required: false
65+
- type: textarea
66+
attributes:
67+
label: Designs and Mockups
68+
description: |
69+
If applicable, provide diagrams or examples to illustrate your enhancement.
70+
- For API changes: sequence diagrams or function signatures
71+
- For architecture changes: component diagrams or data flow
72+
- For integration patterns: code examples or workflow diagrams
73+
placeholder: |
74+
Drag and drop images here, or provide links to external design tools.
75+
76+
For API flows, you can use Mermaid syntax:
77+
```mermaid
78+
sequenceDiagram
79+
Client->>SDK: API Call
80+
SDK->>CloudAPI: Encrypted Request
81+
CloudAPI->>SDK: Response
82+
SDK->>Client: Processed Data
83+
```
84+
validations:
85+
required: false
86+
- type: textarea
87+
attributes:
88+
label: Alternative Solutions
89+
description: |
90+
Please describe any alternative solutions or features you've considered.
91+
placeholder: |
92+
Alternative Approaches:
93+
1. [First alternative approach]
94+
- Pros: [benefits]
95+
- Cons: [drawbacks]
96+
97+
2. [Second alternative approach]
98+
- Pros: [benefits]
99+
- Cons: [drawbacks]
100+
101+
Reason for Preferred Solution:
102+
[Explain why your main proposal is better than these alternatives]
103+
validations:
104+
required: false
105+
- type: checkboxes
106+
id: verification
107+
attributes:
108+
label: Verification
109+
description: Please verify the following before submitting
110+
options:
111+
- label: I have checked that this enhancement hasn't been already proposed
112+
- label: This enhancement aligns with VXControl Cloud SDK's goal of secure cloud integration
113+
- label: I have considered the security and performance implications
114+
- label: I have provided clear use cases and benefits for cybersecurity applications
115+
validations:
116+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<!--
2+
Thank you for your contribution to VXControl Cloud SDK! Please fill out this template completely to help us review your changes effectively.
3+
Any PR that does not include enough information may be closed at maintainers' discretion.
4+
-->
5+
6+
### Description of the Change
7+
<!--
8+
We must be able to understand the design of your change from this description. Please provide as much detail as possible.
9+
-->
10+
11+
#### Problem
12+
<!-- Describe the problem this PR addresses -->
13+
14+
#### Solution
15+
<!-- Describe your solution and its key aspects -->
16+
17+
<!-- Enter any applicable Issue number(s) here that will be closed/resolved by this PR. -->
18+
Closes #
19+
20+
### Type of Change
21+
<!-- Mark with an `x` all options that apply -->
22+
23+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
24+
- [ ] 🚀 New feature (non-breaking change which adds functionality)
25+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
26+
- [ ] 📚 Documentation update
27+
- [ ] 🔧 Configuration change
28+
- [ ] 🧪 Test update
29+
- [ ] 🛡️ Security update
30+
31+
### Areas Affected
32+
<!-- Mark with an `x` all components that are affected -->
33+
34+
- [ ] SDK Core (Call patterns, Transport, Configuration)
35+
- [ ] Security Framework (PoW, Encryption, Signatures)
36+
- [ ] Data Models (Request/Response types, Validation)
37+
- [ ] Anonymizer Engine (PII/Secrets masking, Pattern recognition)
38+
- [ ] License System (Validation, Introspection, Tier management)
39+
- [ ] Examples (Integration patterns, Usage demonstrations)
40+
- [ ] Documentation (README, API reference, Package docs)
41+
- [ ] Testing (Unit tests, Benchmarks, Integration tests)
42+
43+
### Testing and Verification
44+
<!--
45+
Please describe the tests that you ran to verify your changes and provide instructions so we can reproduce.
46+
-->
47+
48+
#### Test Configuration
49+
```yaml
50+
Go Version:
51+
SDK Version:
52+
Host OS:
53+
Target Services: [Update/Package/Support/AI]
54+
License Type: [Free/Professional/Enterprise]
55+
```
56+
57+
#### Test Steps
58+
1.
59+
2.
60+
3.
61+
62+
#### Test Results
63+
<!-- Include relevant screenshots, logs, or test outputs -->
64+
65+
### Security Considerations
66+
<!--
67+
Describe any security implications of your changes.
68+
For security-related changes, please note any cryptographic modifications, PoW algorithm changes,
69+
anonymization pattern updates, or license validation modifications.
70+
-->
71+
72+
### Performance Impact
73+
<!--
74+
Describe any performance implications and testing done to verify acceptable performance.
75+
Especially important for changes affecting PoW solving, streaming encryption/decryption,
76+
anonymization processing, or connection pooling.
77+
-->
78+
79+
### Documentation Updates
80+
<!-- Note any documentation changes required by this PR -->
81+
82+
- [ ] README.md updates
83+
- [ ] API.md documentation updates
84+
- [ ] Package documentation (doc.go files)
85+
- [ ] Example code updates
86+
- [ ] CONTRIBUTING.md updates
87+
- [ ] Other: <!-- specify -->
88+
89+
### Integration Notes
90+
<!--
91+
Describe any special considerations for integrating this change.
92+
Include any new dependencies, API changes, or breaking changes that affect SDK users.
93+
-->
94+
95+
### Checklist
96+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
97+
98+
#### Code Quality
99+
- [ ] My code follows Go coding standards and project conventions
100+
- [ ] I have added/updated necessary documentation (doc.go, README, API.md)
101+
- [ ] I have added comprehensive tests covering new functionality
102+
- [ ] All new and existing tests pass (`go test ./...`)
103+
- [ ] I have run `go fmt`, `go vet`, and `go mod tidy`
104+
- [ ] Benchmarks added for performance-critical changes
105+
106+
#### Security
107+
- [ ] I have considered security implications of changes
108+
- [ ] Cryptographic operations follow established patterns
109+
- [ ] Sensitive data anonymization implemented where applicable
110+
- [ ] No sensitive information exposed in logs or error messages
111+
- [ ] PoW algorithm changes reviewed for FPGA/GPU resistance
112+
113+
#### Compatibility
114+
- [ ] Changes are backward compatible with existing SDK users
115+
- [ ] Breaking changes are clearly marked and documented
116+
- [ ] Dependencies are properly updated and verified
117+
- [ ] License validation compatibility maintained
118+
119+
#### Documentation
120+
- [ ] Package documentation (doc.go) updated for public APIs
121+
- [ ] Code comments follow project standards (lowercase, focus on why/how)
122+
- [ ] Examples updated to demonstrate new functionality
123+
- [ ] API.md updated for new endpoints or models
124+
125+
### Additional Notes
126+
<!-- Any additional information that would be helpful for reviewers -->

0 commit comments

Comments
 (0)