Skip to content

Commit

Permalink
Improves GitHub Community Standards for Repo (eclipse-basyx#343)
Browse files Browse the repository at this point in the history
* Improves GitHub Community Standards for Repo

* Updates README and migrates old CONTRIBUTING

* Makes link in CONTRIBUTING relative
  • Loading branch information
aaronzi authored Jul 22, 2024
1 parent 061b267 commit 42a7271
Show file tree
Hide file tree
Showing 11 changed files with 750 additions and 53 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
18 changes: 18 additions & 0 deletions .github/CODING_CONVENTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Coding conventions

This document outlines the coding standards and best practices for BaSyx Java. Adhering to these conventions will help maintain code quality, enhance readability, and ensure that our codebase is easy to maintain and scale.

## General Principles

1. **Consistency**: All contributors are expected to follow the agreed-upon styles and patterns defined in this document.
2. **Readability and Maintainability**: Write clear, understandable code that is easy to maintain and extend.
3. **Performance Considerations**: Always consider performance implications when writing your code.

## BaSyx Java Code Formatter

When working with BaSyx Java ind Eclipse, you should use the BaSyx Java code formatter. The formatter is available in the `BaSyx_Formatting.xml` file in the [docs directory](https://github.com/eclipse-basyx/basyx-java-server-sdk/tree/main/docs/BaSyx_Formatting.xml) of the repository. To use it, follow these steps:

1. Download the `BaSyx_Formatting.xml` file.
2. In Eclipse, go to `Window` > `Preferences` > `Java` > `Code Style` > `Formatter`.
3. Click on `Import` and select the `BaSyx_Formatting.xml` file.
4. Click `Apply and Close`.
78 changes: 78 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# How to contribute to BaSyx

Thanks for your interest in this project.

## Project description

Eclipse BaSyx collects the implementation results of the research project BaSys
4.0. An essential goal of BaSys 4.0 is the use of IT technology for production
systems to enable the concepts of the new Industrie 4.0 paradigm. It develops a
middleware that integrates traditional production systems (e.g. PLC controllers)
and state-of-the art IT technology (BPMN engine, SOA) to enable next generation
of production automation.

* https://projects.eclipse.org/projects/dt.basyx

#### **Did you find a bug?**

* **Do not open up a GitHub issue if the bug is a security vulnerability
in BaSyx**, and instead refer to our [security policy](https://github.com/eclipse-basyx/basyx-java-server-sdk/security).

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/eclipse-basyx/basyx-java-server-sdk/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/eclipse-basyx/basyx-java-server-sdk/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **BaSyx configuration** including relevant **AAS files (AASX, JSON, XML)** for reproducing the issue.

* If possible, use the relevant bug report templates to create the issue.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

* Before submitting, please read the [Contributing to BaSyx](./CODING_CONVENTIONS.md) guide to know more about coding conventions.

#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of BaSyx will generally not be accepted.

#### **Do you intend to add a new feature or change an existing one?**

* Suggest your change using the `feature request` template when opening a new issue.

* Do not open a pull request until you have collected positive feedback about the change.

#### Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation
Development Process and operates under the terms of the Eclipse IP Policy.

#### Eclipse Contributor Agreement

Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).

* http://www.eclipse.org/legal/ECA.php

Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.

For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit

#### Contact

Contact the project developers via the project's "dev" list.

* https://dev.eclipse.org/mailman/listinfo/basyx-dev

#### **Do you want to contribute to the BaSyx documentation?**

* Please go to the [basyx-wiki](https://github.com/eclipse-basyx/basyx-wiki) repository and create a PR there.

Thanks! :heart: :heart: :heart:

The BaSyx Team
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Bug report
about: Create a bug report
title: "[BUG]"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**BaSyx (please complete the following information):**
- BaSyx Version [e.g. v1.3, v2.0]
- BaSyx SDK [e.g. Java, C#, Python]
- AAS Version [e.g. DotAAS V2, DotAAS V3]

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Used Asset Administration files (.aasx/.json/.xml)**
Please drop your AAS files here that were used when the bug was encountered.

**BaSyx configuration**
Provide details about the configuration you used. If possible, attach the configuration as a .zip file.

**System (please complete the following information):**
- OS: [e.g. Windows, Linux]
- CPU architecture: [e.g. x86, arm]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
13 changes: 13 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security Policy

## Reporting a Vulnerability

Please report (suspected) security vulnerabilities to **[email protected]**. You will receive a response from us within 48 hours. After the initial reply, we will keep you updated on the progress towards a fix and full announcement, and may ask for additional information or guidance.

## Disclosure Policy

We ask all security researchers to keep vulnerabilities and communications around vulnerability submissions confidential until we resolve the issue. We will provide a public acknowledgment after the issue is resolved.

## Rewards

If you report a security issue that we confirm and fix, we may acknowledge your contribution in the release notes for the fix.
15 changes: 15 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

# Maintain dependencies for Maven
- package-ecosystem: "maven"
directory: "/"
schedule:
interval: "weekly"
25 changes: 25 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Pull Request Template

## Description of Changes

Please provide a brief summary of what you have changed in this pull request. Be clear and concise.

## Related Issue

If this pull request is related to an existing issue, please link that issue using the format `#issue_number`.

## BaSyx Configuration for Testing

Describe any specific configuration settings or environment setup required to test these changes effectively. If possible, please provide the BaSyx configuration as .zip file.

## AAS Files Used for Testing

Please provide any AAS files that were used in the testing of these changes. Include a brief descriptions of their relevance to the changes being proposed.

## Additional Information

Include any additional information or context that could be useful for the reviewer. This could include challenges faced, alternative solutions that were considered, etc.

---

Please ensure that you have tested your changes thoroughly before submitting the pull request.
Loading

0 comments on commit 42a7271

Please sign in to comment.