Skip to content

Commit 4c494bc

Browse files
committed
update .reuse and README.md
1 parent 53c0b27 commit 4c494bc

File tree

2 files changed

+10
-37
lines changed

2 files changed

+10
-37
lines changed

.reuse/dep5

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2-
Upstream-Name: <YOUR-REPO-NAME>
3-
Upstream-Contact: <YOUR-CONTACT (MAIL ADDRESS ETC.)>
4-
Source: <https://github.com/sap/YOUR-REPO-NAME>
2+
Upstream-Name: component-operator-runtime
3+
Upstream-Contact: SAP_ERP4SME_DevOps@sap.com
4+
Source: https://github.com/sap/component-operator-runtime
55
Disclaimer: The code in this project may include calls to APIs ("API Calls") of
66
SAP or third-party products or services developed outside of this project
77
("External Products").
@@ -24,14 +24,6 @@ Disclaimer: The code in this project may include calls to APIs ("API Calls") of
2424
you any rights to use or access any SAP External Product, or provide any third
2525
parties the right to use of access any SAP External Product, through API Calls.
2626

27-
Files: <YOUR-FILE-OR-FOLDER-LIST>
28-
Copyright: <YEARS-RELEVANT-FOR-YOUR-PROJECT> SAP SE or an SAP affiliate company and <YOUR-PROJECT-NAME> contributors
27+
Files: **
28+
Copyright: 2023 SAP SE or an SAP affiliate company and component-operator-runtime contributors
2929
License: Apache-2.0
30-
31-
Files: <THIRD-PARTY-FILE-OR-FOLDER-LIST>
32-
Copyright: <COPYRIGHT-OF-THIRD-PARTY-CODE>
33-
License: <LICENSE-OF-THIRD-PARTY-CODE>
34-
35-
Files: <ANOTHER-THIRD-PARTY-FILE-OR-FOLDER-LIST>
36-
Copyright: <COPYRIGHT-OF-ANOTHER-THIRD-PARTY-CODE>
37-
License: <LICENSE-OF-ANOTHER- THIRD-PARTY-CODE>

README.md

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,18 @@
1-
# SAP Repository Template
2-
3-
Default templates for SAP open source repositories, including LICENSE, .reuse/dep5, Code of Conduct, etc... All repositories on github.com/SAP will be created based on this template.
4-
5-
## To-Do
6-
7-
In case you are the maintainer of a new SAP open source project, these are the steps to do with the template files:
8-
9-
- Check if the default license (Apache 2.0) also applies to your project. A license change should only be required in exceptional cases. If this is the case, please change the [license file](LICENSE).
10-
- Enter the correct metadata for the REUSE tool. See our [wiki page](https://wiki.wdf.sap.corp/wiki/display/ospodocs/Using+the+Reuse+Tool+of+FSFE+for+Copyright+and+License+Information) for details how to do it. You can find an initial .reuse/dep5 file to build on. Please replace the parts inside the single angle quotation marks < > by the specific information for your repository and be sure to run the REUSE tool to validate that the metadata is correct.
11-
- Adjust the contribution guidelines (e.g. add coding style guidelines, pull request checklists, different license if needed etc.)
12-
- Add information about your project to this README (name, description, requirements etc). Especially take care for the <your-project> placeholders - those ones need to be replaced with your project name. See the sections below the horizontal line and [our guidelines on our wiki page](https://wiki.wdf.sap.corp/wiki/display/ospodocs/Guidelines+for+README.md+file) what is required and recommended.
13-
- Remove all content in this README above and including the horizontal line ;)
14-
15-
***
16-
17-
# Our new open source project
1+
# Kubernetes Component Operator Runtime
182

193
## About this project
204

21-
*Insert a short description of your project here...*
22-
23-
## Requirements and Setup
24-
25-
*Insert a short description what is required to get your project running...*
5+
A framework to support development of Kubernetes operators managing Kubernetes components.
6+
Documentation can be found [here](https://sap.github.io/component-operator-runtime).
267

278
## Support, Feedback, Contributing
289

29-
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/<your-project>/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
10+
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/component-operator-runtime/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
3011

3112
## Code of Conduct
3213

3314
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
3415

3516
## Licensing
3617

37-
Copyright (20xx-)20xx SAP SE or an SAP affiliate company and <your-project> contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/<your-project>).
18+
Copyright 2023 SAP SE or an SAP affiliate company and component-operator-runtime contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/component-operator-runtime).

0 commit comments

Comments
 (0)