Skip to content

Commit 01f3794

Browse files
golluroSICKAGgolluroSICKAG
authored
Initial commit
0 parents  commit 01f3794

File tree

8 files changed

+163
-0
lines changed

8 files changed

+163
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] - [ShortDescription]"
5+
labels: bug
6+
assignees: golluroSICKAG
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**CSK module:**
14+
- Version: [e.g. 1.2.0]
15+
16+
**AppSpace device used:**
17+
- Type: [e.g. SIM2500, SAE, ...]
18+
- Firmware [e.g. ver1.3.0]
19+
20+
**To Reproduce**
21+
Steps to reproduce the behavior:
22+
1. Go to '...'
23+
2. Click on '....'
24+
3. ...
25+
4. See error
26+
27+
**Expected behavior**
28+
A clear and concise description of what you expected to happen.
29+
30+
**Screenshots**
31+
If applicable, add screenshots to help explain your problem.
32+
33+
**Additional context**
34+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/custom.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: golluroSICKAG
7+
8+
---
9+
10+

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FeatureRequest] - [ShortDescription]"
5+
labels: enhancement
6+
assignees: golluroSICKAG
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem / user story is.
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Version x.x.x
2+
3+
## New features
4+
5+
### ...
6+
7+
## Improvements
8+
9+
### ...
10+
11+
## Bugfix
12+
13+
### ...
14+
15+
## Following tasks were checked
16+
17+
- [ ] Module is coded and structured according to the "Developing guideline for modules" described within the CSK documentation
18+
- [ ] All functions/events/parameters are documented within the manifest documentation
19+
- [ ] The manifest description of the main CROWN includes main information about the purpose of the module and how to use it in general
20+
- [ ] API docu based on the manifest was created and stored within the "docu"-folder of the repository
21+
- [ ] Internal LUA code documentation exists for variables and non served functions
22+
- [ ] All relevant infos are logged via the SharedLogger 'ModuleLogger'
23+
- [ ] Module supports persistent data feature based on 'CSK_Module_PersistentData'
24+
- [ ] Module supports user management based on 'CSK_Module_UserManagement'
25+
- [ ] No open "ToDos" within the code or at least clearly explained comments why they exist...
26+
- [ ] "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)
27+
- [ ] Meaningful IDs used for UI elements
28+
- [ ] Module was tested on an AppSpace device (at least on SICK AppEngine) with no error message
29+
- [ ] README.md is up to date (incl. info of device + firmware the module was tested with)
30+
- [ ] CHANGELOG.md is up to date

‎CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
## Release 0.1.0
5+
- Initial commit
6+
7+
### New features
8+
- ...
9+
10+
### Improvements
11+
- ...
12+
13+
### Bugfix
14+
- ...

‎LICENSE

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

‎README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# CSK_Module_[MODULENAME]
2+
## INFO: Draft version. Not further developed / tested so far! Check for available GitHub forks of this repository to see latest updates.
3+
4+
Module / Application to provide [...] functionality.
5+
6+
*If available, please also add a screenshot/gif of the UI of the module here placed within /docu/media/ (see code)*
7+
![](./docu/media/UI_Screenshot.png)
8+
9+
## How to Run
10+
11+
[***...please fill with informations...***]
12+
For further information check out the [documentation](https://raw.githack.com/SICKAppSpaceCodingStarterKit/CSK_Module_[MODULENAME]/main/docu/CSK_Module_[MODULENAME].html) in the folder "docu".
13+
14+
## Information
15+
16+
Tested on:
17+
|Device|Firmware|Module version
18+
|--|--|--|
19+
|e.g. SICK AppEngine|V1.5.0|V0.1.0|
20+
21+
[***optionally***]
22+
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):
23+
24+
* CSK_Module_XYZ (release/tag v1.2.3)
25+
26+
This application / module is part of the SICK AppSpace Coding Starter Kit developing approach.
27+
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.
28+
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.
29+
Please check the [documentation](https://github.com/SICKAppSpaceCodingStarterKit/.github/blob/main/docu/SICKAppSpaceCodingStarterKit_Documentation.md) of CSK for further information.
30+
31+
## Topics
32+
33+
Coding Starter Kit, CSK, Module, SICK-AppSpace, [key_words]

‎docu/media/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Here you can place relevant media files regarding documentation (e.g. screenshots, gifs, ... to use within main README.md of the repository)

0 commit comments

Comments
 (0)