Skip to content

Commit cd162e7

Browse files
CalvinjminCalvinjmin
authored
chore: minor fixes to cleanup repo (#13)
* Clang Format Changes * Remove Obsolete ToDos * Copyright Headers * Example Query pulling from UC * Generic Templates
1 parent b5f5806 commit cd162e7

Some content is hidden

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

48 files changed

+4497
-4221
lines changed

‎.clang-format‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
# Clang-Format configuration for Databricks C++ SDK
3+
4+
BasedOnStyle: LLVM
5+
6+
# Language
7+
Language: Cpp
8+
Standard: c++17
9+
10+
# Indentation
11+
IndentWidth: 4
12+
TabWidth: 4
13+
UseTab: Never
14+
NamespaceIndentation: None
15+
IndentCaseLabels: false
16+
IndentPPDirectives: AfterHash
17+
AccessModifierOffset: -4
18+
19+
# Line breaks
20+
ColumnLimit: 120
21+
AllowShortFunctionsOnASingleLine: Inline
22+
AllowShortIfStatementsOnASingleLine: Never
23+
AllowShortLoopsOnASingleLine: false
24+
AllowShortBlocksOnASingleLine: Empty
25+
AllowShortCaseLabelsOnASingleLine: false
26+
BreakBeforeBraces: Attach
27+
28+
# Spacing
29+
SpaceBeforeParens: ControlStatements
30+
SpaceAfterCStyleCast: false
31+
SpaceAfterTemplateKeyword: true
32+
SpaceBeforeAssignmentOperators: true
33+
SpaceInEmptyParentheses: false
34+
SpacesInParentheses: false
35+
SpacesInSquareBrackets: false
36+
SpacesInAngles: false
37+
38+
# Alignment
39+
AlignAfterOpenBracket: Align
40+
AlignConsecutiveAssignments: false
41+
AlignConsecutiveDeclarations: false
42+
AlignOperands: true
43+
AlignTrailingComments: true
44+
45+
# Pointer and reference alignment
46+
PointerAlignment: Left
47+
ReferenceAlignment: Left
48+
49+
# Include ordering
50+
IncludeBlocks: Regroup
51+
SortIncludes: CaseSensitive
52+
IncludeCategories:
53+
# Main header (e.g., foo.cpp includes "databricks/foo.h" first)
54+
- Regex: '^"databricks/'
55+
Priority: 1
56+
# Other project headers
57+
- Regex: '^".*\.h"'
58+
Priority: 2
59+
# Internal headers
60+
- Regex: '^"\.\./internal/'
61+
Priority: 3
62+
# Standard library
63+
- Regex: '^<[a-z_]+>'
64+
Priority: 4
65+
# Windows headers
66+
- Regex: '^<windows\.h>'
67+
Priority: 5
68+
# ODBC headers
69+
- Regex: '^<sql'
70+
Priority: 6
71+
# Third-party libraries
72+
- Regex: '.*'
73+
Priority: 7
74+
75+
# Other formatting
76+
BinPackArguments: true
77+
BinPackParameters: true
78+
BreakConstructorInitializers: BeforeComma
79+
ConstructorInitializerIndentWidth: 4
80+
ContinuationIndentWidth: 4
81+
Cpp11BracedListStyle: true
82+
FixNamespaceComments: true
83+
KeepEmptyLinesAtTheStartOfBlocks: false
84+
MaxEmptyLinesToKeep: 1
85+
ReflowComments: true
86+
87+
# Penalties (control line breaking decisions)
88+
PenaltyBreakBeforeFirstCallParameter: 19
89+
PenaltyBreakComment: 300
90+
PenaltyBreakString: 1000
91+
PenaltyExcessCharacter: 1000000
92+
PenaltyReturnTypeOnItsOwnLine: 60

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
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+
## Environment
14+
- **OS**: <!-- e.g., macOS 14.0, Ubuntu 22.04, Windows 11 -->
15+
- **Compiler**: <!-- e.g., GCC 11.2, Clang 14, MSVC 2022 -->
16+
- **SDK Version**: <!-- e.g., 0.3.0 -->
17+
- **CMake Version**: <!-- e.g., 3.25.0 -->
18+
- **ODBC Driver**: <!-- e.g., Simba Spark ODBC Driver 2.6.26 -->
19+
20+
## Steps to Reproduce
21+
<!-- Provide detailed steps to reproduce the behavior -->
22+
23+
1.
24+
2.
25+
3.
26+
27+
## Code Sample
28+
<!-- If applicable, add a minimal code sample that demonstrates the issue -->
29+
30+
```cpp
31+
// Your code here
32+
```
33+
34+
## Expected Behavior
35+
<!-- A clear and concise description of what you expected to happen -->
36+
37+
## Actual Behavior
38+
<!-- What actually happened -->
39+
40+
## Error Messages
41+
<!-- If applicable, add any error messages or stack traces -->
42+
43+
```
44+
Paste error messages here
45+
```
46+
47+
## Additional Context
48+
<!-- Add any other context about the problem here -->
49+
50+
- Configuration files (with credentials removed)
51+
- Screenshots
52+
- Related issues or PRs
53+
54+
## Possible Solution
55+
<!-- Optional: suggest a fix or reason for the bug -->
56+
57+
## Checklist
58+
- [ ] I have searched existing issues to ensure this is not a duplicate
59+
- [ ] I have provided all required environment information
60+
- [ ] I have included a minimal code sample that reproduces the issue
61+
- [ ] I have removed any sensitive information (credentials, hostnames, etc.)
62+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 💬 Questions & Discussions
4+
url: https://github.com/calvinjmin/databricks-sdk-cpp/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://calvinjmin.github.io/databricks-sdk-cpp/
8+
about: Read the API documentation
9+
- name: 🔒 Security Vulnerability
10+
url: https://github.com/calvinjmin/databricks-sdk-cpp/security/advisories/new
11+
about: Report a security vulnerability (private)
12+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: feature
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+
<!-- Describe the problem this feature would solve -->
15+
<!-- Example: "I'm frustrated when..." or "It would be helpful if..." -->
16+
17+
## Proposed Solution
18+
<!-- Describe how you'd like this feature to work -->
19+
20+
## Example Usage
21+
<!-- Show how you envision using this feature -->
22+
23+
```cpp
24+
// Example code showing the proposed API
25+
auto result = client.new_feature(...);
26+
```
27+
28+
## Alternatives Considered
29+
<!-- Describe alternative solutions or features you've considered -->
30+
31+
## Additional Context
32+
<!-- Add any other context, screenshots, or examples about the feature request -->
33+
34+
- Related Databricks API documentation
35+
- Similar features in other SDKs (Python, Java, Go, etc.)
36+
- Use cases that would benefit from this feature
37+
38+
## Implementation Considerations
39+
<!-- Optional: Any thoughts on how this might be implemented -->
40+
41+
- Breaking changes?
42+
- Performance implications?
43+
- Backward compatibility?
44+
- Additional dependencies?
45+
46+
## Willingness to Contribute
47+
<!-- Check the option that applies -->
48+
49+
- [ ] I'd like to implement this feature myself
50+
- [ ] I can help test this feature
51+
- [ ] I can provide additional requirements/feedback
52+
- [ ] I'm just suggesting this idea for consideration
53+
54+
## Checklist
55+
- [ ] I have searched existing issues to ensure this is not a duplicate
56+
- [ ] I have clearly described the feature and its benefits
57+
- [ ] I have considered backward compatibility
58+

‎.github/pull_request_template.md‎

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,42 @@
11
## Description
2-
32
<!-- Briefly describe what this PR does -->
43

5-
## Type of Change
4+
Closes #
65

6+
## Type of Change
77
- [ ] Bug fix
88
- [ ] New feature
99
- [ ] Breaking change
10-
- [ ] Documentation update
10+
- [ ] Documentation
11+
- [ ] Other: <!-- specify -->
1112

12-
## Testing
13+
## Changes
14+
<!-- List key changes -->
15+
-
16+
-
1317

14-
<!-- How has this been tested? -->
18+
## Testing
19+
<!-- How did you test this? -->
20+
- [ ] Added/updated tests
21+
- [ ] All tests pass (`make test`)
22+
- [ ] Tested manually
1523

1624
## Checklist
25+
- [ ] Code follows style guidelines (`make format`)
26+
- [ ] Self-reviewed my code
27+
- [ ] Commented complex code
28+
- [ ] Updated documentation/Doxygen comments
29+
- [ ] No new warnings or errors
30+
- [ ] Backward compatible (or documented breaking changes)
31+
32+
<!-- Optional sections - delete if not applicable -->
33+
34+
## Breaking Changes
35+
<!-- Only if applicable - describe impact and migration -->
36+
37+
## Screenshots
38+
<!-- Only if applicable -->
39+
40+
---
1741

18-
- [ ] Code builds successfully
19-
- [ ] Tests pass
20-
- [ ] Documentation updated (if needed)
21-
- [ ] Update version and tag
42+
By submitting this PR, I confirm my contribution is made under the MIT License.

0 commit comments

Comments
 (0)