Skip to content

Commit a0bf0d6

Browse files
324 make repository compliant to alliander ospo standards (#339)
* Add missing docs from ospo checklist, template names still need to be updated Signed-off-by: Rosalie <[email protected]> * Update placeholder values with the correct values, and add some extra text to the README.md Signed-off-by: Rosalie <[email protected]> --------- Signed-off-by: Rosalie <[email protected]>
1 parent 6131ee9 commit a0bf0d6

File tree

5 files changed

+63
-3
lines changed

5 files changed

+63
-3
lines changed

docs/PROJECT_GOVERNANCE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Maintainers are responsible for maintaining parts of the code-base. Maintainers
3737

3838
The current maintainers of this project are:
3939
1. Jelmer de Wolde - Team RCDT
40-
1. Yuri van Warmerdam - Team RCDT
40+
1. Peter Geurts - Team RCDT
41+
1. Rosalie van Ark - Team RCDT
4142

4243
## Contributors
4344

docs/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ SPDX-License-Identifier: Apache-2.0
66

77
# RCDT Robotics
88

9+
This repository shares all developments happening within the Alliander Robotics team. Projects include inspection robotics, gas leak detection, and operating robots under voltage.
10+
11+
# Goals for sharing
12+
Our goal for sharing this software is to encourage research on robotic implementations in the energy network to help with the energy transition. The software is not intended for production use.
13+
914
| [![drawing](img/logo/github.jpg)](https://github.com/alliander-opensource/rcdt_robotics) | [![drawing](img/logo/read_the_docs.jpg)](https://alliander-opensource.github.io/rcdt_robotics) |
1015
| - | - |
1116

@@ -21,4 +26,4 @@ This project is licensed under the Apache License Version 2.0 - see [licence](..
2126

2227
## Contributing
2328

24-
Please read [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md), [CONTRIBUTING](CONTRIBUTING.md), and [PROJECT GOVERNANCE](PROJECT_GOVERNANCE.md) for details on the process for submitting pull requests to us.
29+
Please read [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md), [CONTRIBUTING](CONTRIBUTING.md), [PROJECT GOVERNANCE](PROJECT_GOVERNANCE.md), and [SUPPORT](SUPPORT.md) for details on the process for submitting pull requests to us.

docs/SECURITY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!--
2+
SPDX-FileCopyrightText: Alliander N. V.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
7+
# Security
8+
9+
At Alliander, we consider the security of our systems and software a top priority. But no matter how much effort we put into system security, there can still be vulnerabilities present.
10+
11+
If you discover a vulnerability, we would like to know about it so we can take steps to address it as quickly as possible. We would like to ask you to help us better protect our clients and our systems.
12+
13+
## Report a security issue
14+
15+
Use the contact details on the [Alliander.com Vulnerability Reporting page](https://www.alliander.com/en/coordinated-vulnerability-disclosure/).
16+
17+
Please describe clearly how the issue can be reproduced, so we can fix it quickly. Typically, the IP address or URL of the affected system and a description of the vulnerability are sufficient. We may contact you if we need more information about a complex vulnerability.
18+
19+
## Thanks
20+
21+
We don't have a bug bounty program, but we're grateful for all the reports we get. We offer an Alliander Security hoodie as a reward for significant security problems.

docs/SUPPORT.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
SPDX-FileCopyrightText: Alliander N. V.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
7+
# Getting help
8+
9+
There are a few ways to connect with the `rcdt_robotics` project:
10+
11+
* submit an issue
12+
* send an email to: [email protected]
13+
14+
## How to ask for help, suggest a feature, or give recommendations
15+
16+
If you have trouble installing, building, or using the `rcdt_robotics` project, but you don't think you've encountered a genuine bug, you can ask a question in the Issues tab of the repository.
17+
18+
If you have an idea for a new feature or a recommendation for existing features or documentation, you can also propose it in the Issues tab.
19+
20+
## How to report a bug
21+
22+
This project manages bug and enhancement using the GitHub issue tracker.
23+
The various issue templates will guide you on making an effective report.
24+
25+
## How to report a security vulnerability
26+
27+
If you think you've found a potential vulnerability in this project, please see [Security](SECURITY.md) for how to responsibly disclose it.
28+
29+
## Contributing a fix
30+
31+
Please see [Contributing](CONTRIBUTING.md) for how to make a project contribution.

docs/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,6 @@
2929

3030
CODE_OF_CONDUCT.md
3131
CONTRIBUTING.md
32-
PROJECT_GOVERNANCE.md
32+
PROJECT_GOVERNANCE.md
33+
SECURITY.md
34+
SUPPORT.md

0 commit comments

Comments
 (0)