Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@

# 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, caste, color, 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 <info@devtank42.de>. 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.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

78 changes: 78 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Contributing to Plugwerk

Plugwerk welcomes contributions from humans and AI agents alike. This file
covers org-wide expectations. **For repository-specific build, test, and
style instructions, read the per-repo `CONTRIBUTING.md`, `AGENTS.md`, or
`CLAUDE.md` first** — those override anything written here when a conflict
exists.

## Before You Start

1. **Look for an existing issue** describing what you want to change. If
none exists, open one first for non-trivial work, so we can align on
the approach before code is written.
2. **Read the repo's `AGENTS.md`** (or `CLAUDE.md`) if present. It
captures conventions, build commands, and the project's
architecture in one place.
3. **Check open PRs** to avoid duplicate work.

## Branch Naming

Use a short, type-prefixed branch name that references the issue when
applicable:

- `feat/123-short-description` for new features
- `fix/456-bug-description` for bug fixes
- `refactor/<area>-<purpose>` for refactors without a tracking issue
- `docs/<area>` for docs-only changes

## Commits

Follow [Conventional Commits](https://www.conventionalcommits.org/):

```
<type>: <imperative description>

<optional body explaining why, not what>
```

Common types: `feat`, `fix`, `refactor`, `docs`, `test`, `chore`,
`perf`, `ci`. Keep subject lines under 72 characters.

## Pull Requests

- Reference the issue you are closing (`Closes #123`).
- Keep PRs focused — one logical change per PR.
- Include a test for any behaviour change unless the affected file is
covered by an explicit "no test needed" rule in the repo's docs.
- Wait for CI to be green before requesting review.

## Contributor License Agreement

Plugwerk is licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0)
with a parallel commercial-licensing track. To keep both options open
for the project, **first-time contributors must sign a CLA** before
their first PR can be merged. The current CLA text and signing
instructions live in [`plugwerk/plugwerk/CLA.md`](https://github.com/plugwerk/plugwerk/blob/main/CLA.md);
the signing process is the same for contributions to any repo in this
org.

If you are unsure whether you have already signed, ask in the PR — the
maintainers will check and let you know.

## Code of Conduct

Participation in this org is governed by the
[Code of Conduct](./CODE_OF_CONDUCT.md). Be respectful in issues, PRs,
discussions, and any other channel where you interact with the
community.

## Reporting Security Issues

Do not open public issues for security problems. See the
[Security Policy](./SECURITY.md) for the private reporting channels.

## Questions

Open a [GitHub Discussion](https://github.com/orgs/plugwerk/discussions)
on the relevant repository, or check the [Support guide](./SUPPORT.md).
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Sponsor button configuration for the plugwerk organization.
#
# Currently empty — there is no public sponsorship channel yet, and an
# empty config is preferable to pointing at a placeholder profile that
# would erode trust if a visitor clicked through.
#
# To enable the GitHub "Sponsor" button across all org repos, add at
# least one of the supported keys below. See:
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository
#
# Examples (uncomment and edit when ready):
# github: [bigpuritz]
# custom: ["https://example.com/sponsor"]
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: Bug report
description: Report a reproducible defect in a plugwerk repository.
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug report.

**Before submitting:** please search [existing issues](https://github.com/plugwerk) to avoid duplicates, and confirm you are running a recent version.

For suspected security vulnerabilities, **do not file a public issue** — see the [Security Policy](https://github.com/plugwerk/.github/blob/main/.github/SECURITY.md).

- type: input
id: summary
attributes:
label: Summary
description: One-sentence description of the bug.
placeholder: e.g. "Catalog endpoint returns 500 when namespace contains a hyphen"
validations:
required: true

- type: dropdown
id: repo
attributes:
label: Affected repository
description: Which plugwerk repo is this about?
options:
- plugwerk/plugwerk
- plugwerk/examples
- plugwerk/website
- other (specify in summary)
validations:
required: true

- type: input
id: version
attributes:
label: Version / commit SHA
description: Output of `git rev-parse HEAD` or the release tag you are on.
placeholder: e.g. "v0.5.2" or "abc1234"
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: A minimal sequence of steps that reproduces the bug. Include commands, requests, or configuration snippets as needed.
placeholder: |
1. Start the stack with `docker compose up`
2. POST to `/api/...` with payload `...`
3. Observe response
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behaviour
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behaviour
description: What happened instead. Include any error messages or stack traces.
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: OS, JVM / Node version, browser (if relevant), database, deployment target.
placeholder: |
- OS: macOS 15.4
- JVM: Temurin 21.0.7
- Browser: Firefox 138
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs (optional)
description: Relevant log output. Trim to the few lines around the failure to keep this readable.
render: shell
validations:
required: false

- type: checkboxes
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/plugwerk/.github/blob/main/.github/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow the Plugwerk Code of Conduct.
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Question or design discussion
url: https://github.com/orgs/plugwerk/discussions
about: For usage questions, design discussions, or "is this the right approach?" — please use Discussions instead of Issues.
- name: Security vulnerability
url: https://github.com/plugwerk/.github/blob/main/.github/SECURITY.md
about: Do not file a public issue. Read the Security Policy for the private reporting channels.
- name: Commercial licensing inquiry
url: mailto:info@devtank42.de
about: For commercial licensing, dedicated support, or custom-development services.
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Feature request
description: Propose a new feature or enhancement.
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for proposing a feature.

Before submitting, search [existing issues and discussions](https://github.com/plugwerk) — the idea may already be in flight.

For exploratory ideas without a concrete use case, prefer opening a [GitHub Discussion](https://github.com/orgs/plugwerk/discussions) instead.

- type: input
id: summary
attributes:
label: Summary
description: One-sentence description of the proposed feature.
validations:
required: true

- type: dropdown
id: repo
attributes:
label: Affected repository
options:
- plugwerk/plugwerk
- plugwerk/examples
- plugwerk/website
- other (specify in motivation)
validations:
required: true

- type: textarea
id: motivation
attributes:
label: Motivation
description: What problem does this solve? Who benefits, and how often does the underlying need come up? Concrete user stories help us prioritize.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: How would you like this to work? Sketch the API, UI, or workflow as concretely as you can.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other approaches you weighed and why they fall short.
validations:
required: false

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Links to prior discussion, related issues, screenshots, mockups, or external references.
validations:
required: false

- type: checkboxes
id: code-of-conduct
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/plugwerk/.github/blob/main/.github/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow the Plugwerk Code of Conduct.
required: true
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Summary

Brief description of changes.

## Related Issues

Closes #

## Type of Change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactoring
- [ ] CI/Build

## Checklist

- [ ] Tests pass locally
- [ ] Documentation updated (if applicable)
- [ ] No secrets or credentials committed
- [ ] Commit messages follow Conventional Commits
- [ ] CLA signed (first-time contributors: post the sign comment below, or it has already been signed)

## AI Agent Disclosure

- [ ] This PR was authored by a human
- [ ] This PR was authored by an AI agent (specify: _______)
- [ ] This PR was co-authored by human + AI agent
Loading