OpenSCD is used as a upstream dependency for CoMPAS. CoMPAS provides back-end services. OpenSCD is purely browser based and acts as a GUI for CoMPAS. Since CoMPAS is active collaborating with OpenSCD; OpenSCD shares some LF energy infrastructure e.g. Slack and the CoMPAS maillinglist. OpenSCD is an official LF energy project. The OpenSCD product vision can be found on Github: .github/README.md at main · openscd/.github · GitHub
This page contains suggestions for governance (the guidelines and customs that define who gets to do what—and how they are supposed to do it) on the OpenSCD project. Understanding the guidelines and customs will enable you to successfully and positively contribute to OpenSCD. Until now we have worked without obligations, which causes a very low velocity and also confusion. You are encouraged to collaborate on these guidelines and customs with the team. Just let the individual authors know or mention ideas or suggestions that benefit the collaboration within our team in one of our meetings. We shall also ask you Thanks for collaborating! |
The OpenSCD project started by Omicron Electronics and contains contributions from Alliander, SprintEins, Transpower and more. It currently has no project charter yet like CoMPAS does. The way we set up governance should create clarity on how we work together, having a good time and creating great software. By experience, we see that some guidelines need to be in place in order to be effective.
OpenSCD administration structure
In order to be more clear on the roles and responsibilities in OpenSCD, a governance setup is needed. In order to be effective as an open source community; clear structures and guidelines are needed to prevent confusion. This becomes more urgent with the move towards OpenSCD-core where the plug-ins/components can be in separate repositories.
Organization level idea
Administrative rights for the github.com/openscd organisation have been with active contributor.
As more parties have taken an interest in the project since then, we could set up something analogous to a technical steering committee with a representative from each contributing party (Alliander, OMICRON, TransPower, and others as they join) who meet monthly to make overarching organization-wide decisions, appoint maintainers for individual repositories, and adopt new repositories into the organization and who are given administrative rights for the GitHub @openscd
organization. (not active at this point)
To be decided on organization level by the OpenSCD TSC
Repository maintainer:
Ultimate authority on a specific OpenSCD plugin/core. The maintainer is trusted to make decisions for a specific set of functionality bundled within a plugin/functionality.
The maintainer's responsibilities include:
The maintainer ask other developers to help with responsibility.
Recommendations for maintainers
If decisions affect a big group, please use the refinement process to get buy-in and feedback. Examples include: API changes on OpenSCD-core are something to discuss since is affects plug-in builders.
Take advantage of the Way of Working guidelines
Joining the OpenSCD organisation on Github
Why having your plug-in into the OpenSCD Github organisation?
Why not add you plug-in to the OpenSCD organisation?
If you don't like to interact with the open source community or it is very vendor specific.
History
OpenSCD project was first published by OMICRON in 2020.
.github/History.md at main · openscd/.github
Open Questions:
Maintainer list
Repository | Maintainer | Backup/Support |
---|---|---|
Open-scd-core | ||
openscd.github.io | (auto-generated repo) | |
Open-scd | ||
xmlvalidate.js | Christian | |
oscd-filteredlist | Steffen | |
oscd-scl | Daniel | |
oscd-tree-grid | Christian | |
oscd-form-components | Pascal | |
oscd-cleanup | Daniel | |
oscd-subscriber-later-binding | Daniel | |
oscd-component | Steffen | |
.github | Ben van 't Ende | |
To defined later: | ||
oscd-save | ||
oscd-open | ||
open-scd-wizarding | ||
oscd-dialog | ||
oscd-action-icon | ||
oscd-form-elements | ||
oscd-action-pane | ||
oscd-action-translate (can be removed?) | ||
oscd-component | ||
oscd-SCL |