Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] - [ShortDescription]"
+labels: bug
+assignees: golluroSICKAG
+
+---
+
+**Describe the bug**  
+A clear and concise description of what the bug is.
+
+**CSK module:**
+ - Version: [e.g. 1.2.0]
+
+**AppSpace device used:**
+ - Type: [e.g. SIM2500, SAE, ...]
+ - Firmware [e.g. ver1.3.0]
+
+**To Reproduce**  
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. ...
+4. See error
+
+**Expected behavior**  
+A clear and concise description of what you expected to happen.
+
+**Screenshots**  
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**  
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: golluroSICKAG
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FeatureRequest] - [ShortDescription]"
+labels: enhancement
+assignees: golluroSICKAG
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem / user story is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+# Version x.x.x
+
+## New features
+
+### ...
+
+## Improvements
+
+### ...
+
+## Bugfix
+
+### ...
+
+## Following tasks were checked
+
+- [ ] Module is coded and structured according to the "Developing guideline for modules" described within the CSK documentation
+- [ ] All functions/events/parameters are documented within the manifest documentation
+- [ ] The manifest description of the main CROWN includes main information about the purpose of the module and how to use it in general
+- [ ] API docu based on the manifest was created and stored within the "docu"-folder of the repository
+- [ ] Internal LUA code documentation exists for variables and non served functions
+- [ ] All relevant infos are logged via the SharedLogger 'ModuleLogger'
+- [ ] Module supports persistent data feature based on 'CSK_Module_PersistentData'
+- [ ] Module supports user management based on 'CSK_Module_UserManagement'
+- [ ] No open "ToDos" within the code or at least clearly explained comments why they exist...
+- [ ] "Version" key in app manifest was updated following semantic versioning (and use '0.x.y' for test / experimental modules which are not yet ready to be officially released)
+- [ ] Meaningful IDs used for UI elements
+- [ ] Module was tested on an AppSpace device (at least on SICK AppEngine) with no error message
+- [ ] README.md is up to date (incl. info of device + firmware the module was tested with)
+- [ ] CHANGELOG.md is up to date

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## Release 0.1.0
+- Initial commit
+
+### New features
+- ...
+
+### Improvements
+- ...
+
+### Bugfix
+- ...

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 SICK AppSpace Coding Starter Kit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,31 @@
+# CSK_Module_[ModuleName]
+
+Module / Application to provide [...] functionality.
+
+*If available, please also add a screenshot/gif of the UI of the module here placed within /docu/media/ (see code)*
+![](https://github.com/SICKAppSpaceCodingStarterKit/[REPO_OF_MODULE]/blob/main/docu/media/UI_Screenshot.png)
+
+## How to Run
+
+[***...please fill with informations...***]  
+For further information check out the [documentation](https://raw.githack.com/SICKAppSpaceCodingStarterKit/[REPO_OF_MODULE]/main/docu/CSK_Module_[MODULENAME].html) [update link] in the folder "docu".
+
+## Information
+
+Tested on:
+[Device] - [firmware]
+...
+
+[***optionally***]
+Following CSK modules are used for this application via Git subtrees and should NOT be further developed within this repository (see [contribution guideline](https://github.com/SICKAppSpaceCodingStarterKit/.github/blob/main/Contribution_Guideline.md) of this GitHub organization):  
+
+  * CSK_Module_XYZ (release/tag v1.2.3)
+
+This application / module is part of the SICK AppSpace Coding Starter Kit developing approach.  
+It is programmed in an object oriented way. Some of the modules use kind of "classes" in Lua to make it possible to reuse code / classes in other projects.  
+In general it is not neccessary to code this way, but the architecture of this app can serve as a sample to be used especially for bigger projects and to make it easier to share code.  
+Please check the [documentation](https://github.com/SICKAppSpaceCodingStarterKit/.github/blob/main/docu/SICKAppSpaceCodingStarterKit_Documentation.md) of CSK for further information.  
+
+## Topics
+
+Coding Starter Kit, CSK, Module, SICK-AppSpace, [key_words]

docu/media/README.md

@@ -0,0 +1 @@
+Here you can place relevant media files regarding documentation (e.g. screenshots, gifs, ... to use within main README.md of the repository)