This is a template repo for Cumulocity-IoT related open-source repos at Cumulocity IoT Organization. It contains basic guidelines for
- Naming the Repo
- FOSS Licensing
- Topics
- README.md structure
- GitHub Setting
Click here Use this template to create a new repo based on this template.
- Use lower case names. Combine words with a "-". Avoid using camelCase or other separators.
- Follow the pattern: [productname]-[reponame]-[productfeature].
- Examples for good repo names: "cumulocity-kpi-trend-widget", "cumulocity-hono-microservice"
- Examples for bad repo names: "C8YPythonAgent", "EPLApps_Samples"
Please make sure that you add a meaningful description to your repo.
Before you publish your repository please remove all sensitive data like credentials from any files especially property files. Common credentials published are:
- c8y.bootstrap.password - used by microservices to connect locally
- c8y.bootstrap.user - used by microservices to connect locally
We strongly suggest that you use the Apache 2.0 License. If you use this repo as a template the license will be automatically applied to your repo.
If you don't use this template you should select the Apache License on repo creation:
If you use open-source 3rd Party Software please check the license compatibility
Each file that contains code from yourself should contain a copyright header in the following format:
Copyright (c) 2024 Cumulocity GmbH, Düsseldorf, Germany and/or its subsidiaries and/or its affiliates and/or their licensors.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
For Cumulocity IoT content please add the topics
- cumulocity-iot
- iot-analytics
Also add one or multiple topics of the following categories:
- 'agent' or 'cumulocity-agent'
- 'webapp' or 'cumulocity-webapp'
- 'widget' or 'cumulocity-widget'
- 'client' or 'cumulocity-client'
- 'cli' or 'cumulocity-cli'
- 'microservice' or 'cumulocity-microservice'
- 'example' or 'cumulocity-example'
- 'tutorial' or 'cumulocity-tutorial'
- 'simulator' or 'cumulocity-simulator'
- 'extension' or 'cumulocity-extension'
- 'documentation' or 'cumulocity-documentation'
Beside that you should add additional topics like 'iot' or others which match to the content of your repo.
The README.md should be structured in the following way:
- Overview about the Repo / Component
- Installation
- Run / Quick Start
- Build
- (opt) Release Notes
- (opt) Contributing Guidelines (either part of the README or in a separate CONTRIBUTING.md)
- Footer to TechCommunity
Please always add the following footer to your README.md
These tools are provided as-is and without warranty or support. They do not constitute part of the Cumulocity product suite. Users are free to use, fork and modify them, subject to the license agreement. While Cumulocity GmbH welcomes contributions, we cannot guarantee to include every contribution in the master project.
For more information you can Ask a Question in the TECH Community Forums.
There are multiple settings you can make use of in your repository. First of all we suggest to enable the Code Security and analysis functionality which includes a Dependency graph, Dependabot alerts and Dependabot security updates.
If you have any questions or suggestions regarding this template please create an issue