Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ksevil committed Aug 16, 2022
1 parent 2dbe6ea commit a2e4cf1
Show file tree
Hide file tree
Showing 16 changed files with 1,539 additions and 1 deletion.
147 changes: 147 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
---
Language: Cpp
AccessModifierOffset: 0
AlignAfterOpenBracket: Align
AlignConsecutiveMacros: true
AlignConsecutiveAssignments: false
AlignConsecutiveBitFields: false
AlignConsecutiveDeclarations: false
AlignEscapedNewlines: Left
AlignOperands: Align
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: false
AllowAllConstructorInitializersOnNextLine: false
AllowAllParametersOfDeclarationOnNextLine: false
AllowShortEnumsOnASingleLine: false
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: None
AllowShortLambdasOnASingleLine: None
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: MultiLine
BinPackArguments: false
BinPackParameters: false
BraceWrapping:
AfterCaseLabel: true
AfterClass: true
AfterControlStatement: Always
AfterEnum: true
AfterFunction: true
AfterNamespace: true
AfterObjCDeclaration: true
AfterStruct: true
AfterUnion: true
AfterExternBlock: true
BeforeCatch: true
BeforeElse: true
BeforeLambdaBody: true
BeforeWhile: true
IndentBraces: true
SplitEmptyFunction: true
SplitEmptyRecord: true
SplitEmptyNamespace: true
BreakBeforeBinaryOperators: All
BreakBeforeBraces: Allman
BreakBeforeInheritanceComma: false
BreakInheritanceList: AfterColon
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: true
BreakConstructorInitializers: AfterColon
BreakAfterJavaFieldAnnotations: true
BreakStringLiterals: true
ColumnLimit: 160
CommentPragmas: '^ IWYU pragma:'
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DeriveLineEnding: true
DerivePointerAlignment: false
DisableFormat: false
ExperimentalAutoDetectBinPacking: false
FixNamespaceComments: false
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IncludeBlocks: Preserve
IncludeCategories:
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
Priority: 2
SortPriority: 0
- Regex: '^(<|"(gtest|gmock|isl|json)/)'
Priority: 3
SortPriority: 0
- Regex: '.*'
Priority: 1
SortPriority: 0
IncludeIsMainRegex: '(Test)?$'
IncludeIsMainSourceRegex: ''
IndentCaseLabels: false
IndentCaseBlocks: false
IndentGotoLabels: true
IndentPPDirectives: None
IndentExternBlock: AfterExternBlock
IndentWidth: 2
IndentWrappedFunctionNames: false
InsertTrailingCommas: None
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: None
ObjCBinPackProtocolList: Auto
ObjCBlockIndentWidth: 2
ObjCBreakBeforeNestedBlockParam: true
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: true
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 19
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 60
PointerAlignment: Left
ReflowComments: true
SortIncludes: true
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: false
SpaceBeforeInheritanceColon: false
SpaceBeforeParens: Never
SpaceBeforeRangeBasedForLoopColon: false
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: false
SpacesInConditionalStatement: false
SpacesInContainerLiterals: false
SpacesInCStyleCastParentheses: false
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
Standard: c++03
StatementMacros:
- Q_UNUSED
- QT_REQUIRE_VERSION
TabWidth: 4
UseCRLF: false
UseTab: Never
WhitespaceSensitiveMacros:
- STRINGIZE
- PP_STRINGIZE
- BOOST_PP_STRINGIZE
...
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Official Website
url: https://diodeiot.com
about: Official Diode IoT website
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Feature Request
description: Suggest an idea for this project
labels: ["Type: enhancement"]

body:
- type: markdown
attributes:
value: |
* We welcome any ideas or feature requests! It is helpful if you can explain exactly why the feature would be useful.
* You can take a look to existing issues.
- type: input
id: Area
attributes:
label: Related area
description: Please briefly explain the area of your feature request.
placeholder: eg. Board support, New functionality ...
validations:
required: true

- type: input
id: HW
attributes:
label: Hardware specifications
description: Please provide if your proposal depends on specific hardware.
placeholder: eg. Support for ESP32, Uno ...
validations:
required: true

- type: textarea
id: problem-related
attributes:
label: Is your feature request related to a problem?
description: Please provide a clear and concise description of what the problem is. Add relevant issue link.
placeholder: eg. I'm facing the issue/missing function...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: Please provide a clear and concise description of what you want to happen.
placeholder: eg. When using this function...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Please provide a clear and concise description of any alternative solutions or features you've considered.
placeholder: eg. Choosing other approach wouldn't work, because...

- type: textarea
id: context
attributes:
label: Additional context
description: Please add any other context or screenshots about the feature request here.
placeholder: eg. This would work only when ...

- type: checkboxes
id: confirmation
attributes:
label: I have checked existing list of feature requests and the contribution guide
description: You agree to check all the resources above before opening a new feature request.
options:
- label: I confirm i have checked existing list of feature requests and contribution guide.
required: true
99 changes: 99 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: Issue Report
description: Report any problem here
labels: ["Status: Awaiting triage"]
body:
- type: markdown
attributes:
value: |
* You can take a look to existing issues.
* If still experiencing the issue, please provide as many details as possible below about your hardware, computer setup and code.
- type: textarea
id: other-hw
attributes:
label: Hardware configuration
description: Is anything else attached to the device?
placeholder: eg. GPIO 18 & 19 are connected to I2C devices.
validations:
required: true

- type: textarea
id: sw-version
attributes:
label: Software version
description: What version are you running? If possible, consider updating to the latest version.
placeholder: eg. v1.0.0
validations:
required: true

- type: textarea
id: hw-version
attributes:
label: Hardware version
description: What version are you running?
placeholder: eg. v1.0.0
validations:
required: true

- type: input
id: IDE
attributes:
label: IDE name
description: What IDE are you using?
placeholder: eg. Arduino IDE, PlatformIO, Sloeber ...
validations:
required: true

- type: input
id: os
attributes:
label: Operating System
description: On which OS does this issue occur?
placeholder: eg. macOS 12.1, Windows 10 ...
validations:
required: true

- type: textarea
id: Description
attributes:
label: Description
description: Please describe your problem here and expected behaviour.
placeholder: eg. Can't connect/weird behaviour/wrong function/missing parameter..
validations:
required: true

- type: textarea
id: sketch
attributes:
label: Sketch
description: Please provide full minimal sketch/code which can be run to reproduce your issue.
placeholder: eg. Related part of the code to replicate the issue
render: cpp
validations:
required: true

- type: textarea
id: Debug
attributes:
label: Debug Message
description: Please provide a debug message or error message.
placeholder: Debug output here
render: plain
validations:
required: true

- type: textarea
id: other-remarks
attributes:
label: Other Steps to Reproduce
description: Is there any other information you can think of which will help us reproduce this problem? Any additional info can be added as well.
placeholder: eg. I also tried on other OS, HW...it works correctly on that setup.

- type: checkboxes
id: confirmation
attributes:
label: I have checked existing issues, online documentation and the Troubleshooting Guide
description: You agree to check all the resources above before opening a new issue.
options:
- label: I confirm I have checked existing issues, online documentation and Troubleshooting guide.
required: true
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Pull Request Template for Diode IoT Arduino Libraries

Thank you for creating a pull request to contribute to Diode IoT's GitHub Arduino repository.

Before you open the request, please review the following guidelines and tips to
help it be more easily integrated:

- **Describe the scope of your change i.e. what the change does and what parts of the code were modified**

This will help us understand any risks of integrating the code.

- **Describe any known limitations with your change**

For example if the change doesn't apply to a supported platform of the library please mention it.

- **Please run any tests or examples that can exercise your modified code**

We strive to not break users of the code and running tests/examples helps with this
process.

- **Please make sure all ci-arduino criteria are met before making pull request**

There are strict code quality and documentation rules in Diode IoT Github repository. Plase make sure all ci-arduino checks are met
before making pull request.

Thank you again for contributing. We will try to test and integrate the change
as soon as we can, but be aware we have many GitHub repositories to manage and
can't immediately respond to every request. There is no need to bump or check in
on a pull request (it will clutter the discussion of the request).

Also don't be worried if the request is closed or not integrated, sometimes the
priorities of Diode IoT's GitHub repository (education, ease of use) might not match the priorities of the pull request. Don't fret, the open source community thrives on
forks and GitHub makes it easy to keep your changes in a forked repo.

After reviewing the guidelines above you can delete this text from the pull request.
Loading

0 comments on commit a2e4cf1

Please sign in to comment.