Skip to content

Commit a73dd92

Browse files
authored
Merge branch 'main' into chore/update-to-topic-name-and-regions-in-external-ids
Signed-off-by: Rense Bakker <b.rense@gmail.com>
2 parents c066197 + 2d32788 commit a73dd92

File tree

8 files changed

+676
-213
lines changed

8 files changed

+676
-213
lines changed

.github/workflows/yml-lint.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: YAML Lint
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
lint:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout repository
11+
uses: actions/checkout@v4
12+
13+
- name: Install Prettier
14+
run: npm install --global prettier
15+
16+
- name: Check YAML formatting
17+
run: prettier --check "**/*.yaml"

CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
3+
4+
SPDX-License-Identifier: CC-BY-4.0
5+
-->
6+
7+
8+
# Code of Conduct
9+
10+
## Our Pledge
11+
12+
In the interest of fostering an open and welcoming environment, we as
13+
contributors and maintainers pledge to making participation in our project and
14+
our community a harassment-free experience for everyone, regardless of age, body
15+
size, disability, ethnicity, gender identity and expression, level of
16+
experience, education, socio-economic status, nationality, personal appearance,
17+
race, religion, or sexual identity and orientation.
18+
19+
## Our Standards
20+
21+
Examples of behavior that contributes to creating a positive environment
22+
include:
23+
24+
* Using welcoming and inclusive language
25+
* Being respectful of differing viewpoints and experiences
26+
* Gracefully accepting constructive criticism
27+
* Focusing on what is best for the community
28+
* Showing empathy towards other community members
29+
30+
Examples of unacceptable behavior by participants include:
31+
32+
* The use of sexualized language or imagery and unwelcome sexual attention or
33+
advances
34+
* Trolling, insulting/derogatory comments, and personal or political attacks
35+
* Public or private harassment
36+
* Publishing others' private information, such as a physical or electronic
37+
address, without explicit permission
38+
* Other conduct which could reasonably be considered inappropriate in a
39+
professional setting
40+
41+
## Our Responsibilities
42+
43+
Project maintainers are responsible for clarifying the standards of acceptable
44+
behavior and are expected to take appropriate and fair corrective action in
45+
response to any instances of unacceptable behavior.
46+
47+
Project maintainers have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
50+
contributor for other behaviors that they deem inappropriate, threatening,
51+
offensive, or harmful.
52+
53+
## Scope
54+
55+
This Code of Conduct applies both within project spaces and in public spaces
56+
when an individual is representing the project or its community. Examples of
57+
representing a project or community include using an official project e-mail
58+
address, posting via an official social media account, or acting as an appointed
59+
representative at an online or offline event. Representation of a project may be
60+
further defined and clarified by project maintainers.
61+
62+
63+
## Conflict Resolution
64+
65+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at OSPO@alliander. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
66+
67+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
72+
available at
73+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<!--
2+
SPDX-FileCopyrightText: 'Copyright Contributors to the LSIS project'
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
7+
8+
# How to Contribute
9+
10+
We'd love to accept your patches and contributions to this project. There are
11+
just a few small guidelines you need to follow.
12+
13+
## Ways of contributing
14+
15+
Contribution does not necessarily mean committing code to the repository.
16+
We recognize different levels of contributions as shown below in increasing order of dedication:
17+
18+
1. Keep the API specifications up to date by opening issues or pull requests.
19+
2. Request changes via issues or pull requests.
20+
21+
## Filing bugs, security vulnerability or feature requests
22+
23+
You can file bugs against and feature requests for the project via github issues. Consult [GitHub Help](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/creating-an-issue) for more
24+
information on using github issues.
25+
26+
If you think you've found a potential vulnerability in this project, please
27+
email <lsis@alliander.com> to responsibly disclose it.
28+
29+
## Community Guidelines
30+
31+
This project follows the following [Code of Conduct](CODE_OF_CONDUCT.md).
32+
33+
## REUSE Compliance & Source Code Headers
34+
35+
All the files in the repository need to be [REUSE compliant](https://reuse.software/).
36+
We use the pipeline to automatically check this.
37+
If there are files which are not complying, the pipeline will fail the pull request will be blocked.
38+
39+
This means that every file containing source code must include copyright and license
40+
information. This includes any JS/CSS files that you might be serving out to
41+
browsers. (This is to help well-intentioned people avoid accidental copying that
42+
doesn't comply with the license.)
43+
44+
MPL-2.0 header:
45+
46+
```
47+
SPDX-FileCopyrightText: 'Copyright Contributors to the LSIS project'
48+
SPDX-License-Identifier: MPL-2.0
49+
```
50+
51+
## Signing the Developer Certificate of Origin (DCO)
52+
53+
This project utilize a Developer Certificate of Origin (DCO) to ensure that
54+
each commit was written by the author or that the author has the appropriate rights
55+
necessary to contribute the change.
56+
Specifically, we utilize [Developer Certificate of Origin, Version 1.1](http://developercertificate.org/),
57+
which is the same mechanism that the Linux® Kernel and many other communities use to manage code contributions.
58+
The DCO is considered one of the simplest tools for sign-offs from contributors as the representations are
59+
meant to be easy to read and indicating signoff is done as a part of the commit message.
60+
61+
This means that each commit must include a DCO which looks like this:
62+
63+
`Signed-off-by: Joe Smith <joe.smith@email.com>`
64+
65+
The project requires that the name used is your real name and the e-mail used is your real e-mail.
66+
Neither anonymous contributors nor those utilizing pseudonyms will be accepted.
67+
68+
There are other great tools out there to manage DCO signoffs for developers to make it much easier to do signoffs:
69+
* Git makes it easy to add this line to your commit messages. Make sure the `user.name` and `user.email` are set in your git configs. Use `-s` or `--signoff` to add the Signed-off-by line to the end of the commit message.
70+
* [Github UI automatic signoff capabilities](https://github.blog/changelog/2022-06-08-admins-can-require-sign-off-on-web-based-commits/) for adding the signoff automatically to commits made with the GitHub browser UI. This one can only be activated by the github org or repo admin.
71+
* [GitHub UI automatic signoff capabilities via custom plugin]( https://github.com/scottrigby/dco-gh-ui ) for adding the signoff automatically to commits made with the GitHub browser UI
72+
* Additionally, it is possible to use shell scripting to automatically apply the sign-off. For an example for bash to be put into a .bashrc file, see [here](https://wiki.lfenergy.org/display/HOME/Contribution+and+Compliance+Guidelines+for+LF+Energy+Foundation+hosted+projects).
73+
* Alternatively, you can add `prepare-commit-msg hook` in .git/hooks directory. For an example, see [here](https://github.com/Samsung/ONE-vscode/wiki/ONE-vscode-Developer's-Certificate-of-Origin).
74+
75+
## Code reviews
76+
77+
All patches and contributions, including patches and contributions by project members, require review by one of the maintainers of the project. We
78+
use GitHub pull requests for this purpose. Consult
79+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
80+
information on using pull requests.
81+
82+
## Pull Request Process
83+
Contributions should be submitted as Github pull requests. See [Creating a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) if you're unfamiliar with this concept.
84+
85+
The process for a code change and pull request you should follow:
86+
87+
1. Create a topic branch in your local repository, following the naming format
88+
"feature-[description]". For more information see the Git branching guideline.
89+
1. Make changes, compile, and test thoroughly. Ensure any install or build dependencies are removed before the end of the layer when doing a build. Code style should match existing style and conventions, and changes should be focused on the topic the pull request will be addressed. For more information see the style guide.
90+
1. Push commits to your fork.
91+
1. Create a Github pull request from your topic branch.
92+
1. Pull requests will be reviewed by one of the maintainers who may discuss, offer constructive feedback, request changes, or approve
93+
the work. For more information see the Code review guideline.
94+
1. Upon receiving the sign-off of one of the maintainers you may merge your changes, or if you
95+
do not have permission to do that, you may request a maintainer to merge it for you.
96+
97+
## Attribution
98+
99+
This Contributing.md is adapted from Google
100+
available at
101+
https://github.com/google/new-project/blob/master/docs/contributing.md

0 commit comments

Comments
 (0)