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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug report
description: Report a defect
title: "bug: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug. Please fill the sections below as completely as you can; the more information we have, the faster we can help.

- type: input
id: version
attributes:
label: "Crate(s) and version"
description: "e.g. `my_crate 0.1.0`"
placeholder: "my_crate 0.1.0"
validations:
required: true

- type: input
id: rust_version
attributes:
label: Rust toolchain
description: Output of `rustc --version`
placeholder: rustc 1.88.0 (stable)
validations:
required: true

- type: input
id: os
attributes:
label: Operating system
placeholder: Ubuntu 24.04 / macOS 14.5 / Windows 11
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Minimal sequence of actions or a code snippet that triggers the issue.
placeholder: |
1. ...
2. ...
3. Observe ...
validations:
required: true

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

- type: textarea
id: actual
attributes:
label: Actual behaviour
description: Include error messages, panics or unexpected output.
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs or tracing output
description: "Paste relevant `tracing` output, ideally at `debug` level."
render: shell
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: Anything else worth knowing (custom configuration, manifest excerpt, etc.).
validations:
required: false
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability
url: https://github.com/nubster-opensources/.github/blob/main/SECURITY.md
about: Report vulnerabilities privately by email to security@nubster.com. Never open a public issue.
- name: Questions and discussions
url: https://github.com/orgs/nubster-opensources/discussions
about: For open-ended questions, ideas and design conversations, please use Discussions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request
description: Suggest a new capability or improvement
title: "feat: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature. Concrete use cases beat abstract requests every time.

- type: textarea
id: use_case
attributes:
label: Use case
description: What problem are you trying to solve? What does your code look like today, and why is it painful?
validations:
required: true

- type: textarea
id: proposed_api
attributes:
label: Proposed API or behaviour
description: A code snippet showing the API you would like to see. Even rough is better than nothing.
render: rust
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other crates, patterns or workarounds you have already evaluated.
validations:
required: false

- type: textarea
id: context
attributes:
label: Additional context
description: Links to discussions, related issues, prior art in other ecosystems, etc.
validations:
required: false
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
Thank you for opening a pull request. Please keep the sections below; they
make the review faster.
-->

## Summary

<!-- One paragraph: what does this PR do and why. -->

## Changes

<!-- Bullet list of significant changes. Path-prefixed when useful. -->

## Design decisions

<!-- Explain any non-obvious design choice. Link to discussions or issues if relevant. -->

## Test plan

- [ ] All tests pass (`cargo test --workspace --all-features`)
- [ ] Clippy is clean (`cargo clippy --workspace --all-targets --all-features -- -D warnings`)
- [ ] Documentation is up to date (public API items have doc comments)
- [ ] `CHANGELOG.md` updated under `[Unreleased]`
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# 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 conduct@nubster.com. 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](https://www.contributor-covenant.org), version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

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

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>.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing to Nubster Open Source

Thank you for considering a contribution. This document is the organization-wide default; an individual repository may override it with its own `CONTRIBUTING.md`.

## Conventions

Nubster Open Source projects follow the Nubster general coding standards documented in [nubster-docs](https://github.com/nubster-opensources/nubster-docs/tree/main/docs/reference/coding-standards). In short:

- **Trunk-Based Development** - feature branches `feature/<issue>-<slug>` from `main`, never commit directly on `main`.
- **Conventional Commits** - all commit messages follow the `type(scope): description` format.
- **Rust style** - workspace lints `clippy::all` and `clippy::pedantic` set to `deny`, MSRV pinned in `rust-toolchain.toml` and `Cargo.toml`.
- **No competitor mentions** - the source code, commit messages, pull requests and documentation never name competing tools.
- **English on the public API** - rustdoc comments and public-facing documentation are written in English.

## Local setup

1. Install Rust via [rustup](https://rustup.rs/). The `rust-toolchain.toml` file at the repository root pins the exact version automatically.
2. Install [lefthook](https://github.com/evilmartians/lefthook) and run `lefthook install` to wire up the pre-commit hooks.
3. Verify your setup: `cargo test --workspace --all-features`.

## Discussion before code

Open a discussion or issue before writing code for any non-trivial change. This avoids wasted effort and keeps the design aligned with the project roadmap.

## Contributor License Agreement

Contributions to Nubster Open Source projects are governed by the Nubster Contributor License Agreement, hosted at [github.com/nubster-opensources/cla](https://github.com/nubster-opensources/cla).

On your first pull request, the CLA Assistant bot will automatically prompt you to sign the CLA. Once signed, your signature applies to all current and future contributions to any `nubster-opensources` project.

The CLA is a license grant (not a copyright assignment): you keep the copyright on your contributions and grant Nubster a broad license to use, sub-license, and re-license them.

## License

By contributing, you agree that your contributions will be dual licensed under the terms of the `LICENSE-MIT` and `LICENSE-APACHE` files at the root of the repository you contribute to.
Loading