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
36 changes: 36 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/docker-existing-dockerfile
{
"build": {
"dockerfile": "Dockerfile",
"args": {
"IMAGE": "mcr.microsoft.com/devcontainers/base:ubuntu"
}
},

"features": {},

// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",

// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerFile": "../Dockerfile",

// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [3000],

// Uncomment the next line to run commands after the container is created - for example installing curl.
"postCreateCommand": "bash dev-bootstrap.sh",

// Uncomment when using a ptrace-based debugger like C++, Go, and Rust
// "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],

// Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
// "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],

// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
// "remoteUser": "vscode",

// Set *default* container specific settings.json values on container create.
// "settings": {},
}
15 changes: 15 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CODEOWNERS file
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Default owners for everything in the repo
# These owners will be requested for review when someone opens a pull request
* @cloudandthings/maintainers

# GitHub Actions workflows
/.github/workflows/ @cloudandthings/devops

# Documentation
*.md @cloudandthings/documentation

# Tests
/tests/ @cloudandthings/qa
127 changes: 127 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# 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.
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.
59 changes: 59 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Development environment

We recommend [VSCode](https://code.visualstudio.com/) and [mise-en-place](https://mise.jdx.dev/).

Once `mise` is installed and activated, it will create and activate a Python virtual environment
and install all required development tools defined in `mise.toml`.

Install Python dependencies:

```sh
uv sync --all-extras
```

### Reducing clutter

To improve focus while developing, you may want to configure VSCode to hide all files beginning
with `.` from the Explorer view. Add `"**/.*"` to the `files.exclude` setting.

## Code quality

This project uses [ruff](https://github.com/astral-sh/ruff) for linting and formatting, managed
via pre-commit. Run all hooks before committing:

```sh
pre-commit run -a
```

## Pull Request Process

1. Update the code, examples, and/or documentation where appropriate.
1. Follow [conventional commits](https://www.conventionalcommits.org/) for your commit messages.
1. Run pre-commit hooks locally: `pre-commit run -a`
1. Run tests locally: `mise test`
1. Create a pull request.
1. Once all CI checks pass, notify a reviewer.

Once all outstanding comments and checklist items have been addressed, your contribution will be
merged. Merged PRs will be included in the next release.

## Testing

```sh
mise test
# or directly:
pytest tests/
```

## Releases

Releases are automated via [release-please](https://github.com/googleapis/release-please) based
on [conventional commits](https://www.conventionalcommits.org/). A release will bump the version
in `pyproject.toml`, generate a changelog entry, and publish the package to PyPI.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "bug: "
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: What happened?
description: What did you expect, and what did you get instead?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
render: python
placeholder: |
from dispatchio import ...
validations:
required: true

- type: input
id: versions
attributes:
label: dispatchio version / Python version
placeholder: "e.g., v0.1.0 / Python 3.11"
validations:
required: true
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: true
contact_links:
- name: Questions and Discussions
url: https://github.com/cloudandthings/python-dispatchio/discussions
about: Ask questions and discuss ideas with the community
- name: Security Vulnerability
url: https://github.com/cloudandthings/python-dispatchio/security/advisories/new
about: Report security vulnerabilities privately
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Feature Request
description: Suggest an idea or enhancement
title: "feat: "
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: What would you like?
description: Describe the feature and why it would be useful.
validations:
required: true

- type: textarea
id: example
attributes:
label: Example usage
render: python
placeholder: |
from dispatchio import ...
validations:
required: false
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## What does this PR do?

<!-- Brief description of the change -->

## Checklist

- [ ] `pre-commit run -a` passes locally
- [ ] `mise test` passes locally
- [ ] CI checks pass

Closes #
Loading
Loading