Skip to content

Commit 5cd4891

Browse files
authored
docs: add required docs and codeowners config (#13)
1 parent 98799d2 commit 5cd4891

File tree

5 files changed

+76
-2
lines changed

5 files changed

+76
-2
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# All members of the @com-pas/Alliander team are code owners for this repository
2+
3+
* @com-pas/Alliander

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of Conduct
2+
3+
This project follows the CoMPAS Code of Conduct. Please see the [Code of Conduct documentation](https://com-pas.github.io/contributing/#code-of-conduct) for details on our community standards and expectations.

GOVERNANCE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Governance
2+
3+
This project follows the CoMPAS governance model. See the [governance documentation](https://com-pas.github.io/contributing/GOVERNANCE.html) for details.

README.md

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,65 @@
1-
This is a prototype of an editor type plugin for OpenSCD.
2-
The code is not tested and should not be relied on. It is a playground for new elements defined by the `IEC 61850-7-6` and `IEC 61850-90-30`.
1+
# \<scl-bay-template>
32

3+
## What is this?
4+
5+
This is an editor plugin for ComPAS OpenSCD that helps create and manage bay typicals (templates) for SCL files. It provides functionality for defining reusable bay configurations with functions and subfunctions according to IEC 61850 standards.
6+
7+
## Development
8+
9+
### Start Development Server
10+
11+
```bash
12+
npm install
13+
```
14+
15+
```bash
16+
npm start
17+
```
18+
19+
This will start the development server and automatically open the demo at [http://localhost:8000/demo](http://localhost:8000/demo) where you can test the bay template editor.
20+
21+
### Run Tests
22+
23+
```bash
24+
npm test
25+
```
26+
27+
### Watch Tests
28+
29+
```bash
30+
npm test:watch
31+
```
32+
33+
### Linting and Formatting
34+
35+
```bash
36+
npm run lint # Scan project for linting and formatting errors
37+
npm run format # Fix linting and formatting errors
38+
```
39+
40+
## Usage
41+
42+
### As OpenSCD Plugin
43+
44+
This editor is designed to be used as a plugin within the OpenSCD ecosystem for creating bay templates:
45+
46+
```javascript
47+
{
48+
"name": "Bay Template",
49+
"icon": "edit",
50+
"active": true,
51+
"src": "path/to/scl-bay-template.js"
52+
}
53+
```
54+
55+
## Contributing
56+
57+
Please refer to the [CoMPAS Contributing Guide](https://com-pas.github.io/contributing/) for contribution guidelines.
58+
59+
## Authors
60+
61+
- Jakob Vogelsang
62+
63+
## Project Status
64+
65+
This is an active development project. While functional, it should be considered a prototype and used with appropriate caution in production environments.

SUPPORT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Support
2+
3+
For support and help, see the [CoMPAS contributing guide](https://com-pas.github.io/contributing/SUPPORT.html).

0 commit comments

Comments
 (0)