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
19 changes: 19 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# https://editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 2

[*.{py,toml}]
indent_size = 4

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
22 changes: 15 additions & 7 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,37 +1,45 @@
# CODEOWNERS file for CloudZero open source projects
# CODEOWNERS for CloudZero open source projects
#
# Lines starting with '#' are comments.
# Each line is a file pattern followed by one or more owners.
# Owners can be @usernames, @org/team-names, or email addresses.
#
# For more information, see:
# GitHub only enforces these reviews when branch protection (or rulesets)
# require "Code owner reviews". That setting is what blocks merge on this
# template until @cloudzero/open-source-maintainers approves.
#
# When you copy this file into a new repository:
# 1. Confirm the team exists in the GitHub organization, or replace it.
# 2. Do not invent extra internal team names here.
# 3. Keep the default `*` owner so unmatched paths still have a reviewer.
#
# Docs:
# 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
* @cloudzero/open-source-maintainers

# Python code
# Python
*.py @cloudzero/open-source-maintainers
python/ @cloudzero/open-source-maintainers
pyproject.toml @cloudzero/open-source-maintainers

# JavaScript/TypeScript code
# JavaScript / TypeScript
*.js @cloudzero/open-source-maintainers
*.ts @cloudzero/open-source-maintainers
*.jsx @cloudzero/open-source-maintainers
*.tsx @cloudzero/open-source-maintainers
javascript/ @cloudzero/open-source-maintainers
package.json @cloudzero/open-source-maintainers

# CI/CD configuration
# CI/CD
.github/workflows/ @cloudzero/open-source-maintainers
.github/actions/ @cloudzero/open-source-maintainers

# Documentation
*.md @cloudzero/open-source-maintainers
docs/ @cloudzero/open-source-maintainers

# Docker configuration
# Docker
Dockerfile @cloudzero/open-source-maintainers
docker-compose*.yml @cloudzero/open-source-maintainers
.dockerignore @cloudzero/open-source-maintainers
Expand Down
42 changes: 26 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,43 @@ labels: ''
assignees: ''

---
**Please do not report security vulnerabilities here**. Please disclose all security issues to [security@cloudzero.com](mailto:security@cloudzero.com).

**Thank you in advance for helping us to improve this project!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use [CloudZero Support](mailto:support@cloudzero.com). Finally, to avoid duplicates, please search existing Issues before submitting one here.
# Bug report

By submitting an Issue to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md).
**Please do not report security vulnerabilities here.** Follow
[SECURITY.md](../../SECURITY.md) instead.

### Description
Thank you for helping us improve this project. Fill out the sections below so
we can respond quickly. For usage questions, email
[CloudZero Support](mailto:support@cloudzero.com). Search existing issues
before opening a new one.

> Provide a clear and concise description of the issue, including what you expected to happen.
By submitting an issue you agree to the
[CloudZero Code of Conduct](../../CODE-OF-CONDUCT.md).

### Reproduction
## Description

> Detail the steps taken to reproduce this error, what was expected, and whether this issue can be reproduced consistently or if it is intermittent.
> Provide a clear and concise description of the issue, including what you
> expected to happen.

## Reproduction

> Detail the steps taken to reproduce this error, what was expected, and
> whether this issue can be reproduced consistently or if it is intermittent.
>
> Where applicable, please include:
>
> - Code sample to reproduce the issue
> - Log files (redact/remove sensitive information)
> - Application settings (redact/remove sensitive information)
> - Log files (redact or remove sensitive information)
> - Application settings (redact or remove sensitive information)
> - Screenshots

### Environment
## Environment

> Please provide the following:

- **Version of this project used:**
- **Version of the platform or framework used, if applicable:**
- **Other relevant versions (language, server software, OS, browser):**
- **Cloud provider and cloud services used (EKS, K8S, EC2, Etc...)**
- **Other modules/plugins/libraries that might be involved:**
>
> - **Version of this project used:**
> - **Version of the platform or framework used, if applicable:**
> - **Other relevant versions (language, server software, OS, browser):**
> - **Cloud provider and cloud services used (EKS, Kubernetes, EC2, and so on)**
> - **Other modules, plugins, or libraries that might be involved:**
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ body:
attributes:
value: |
**Please do not report security vulnerabilities here.**
Email [security@cloudzero.com](mailto:security@cloudzero.com) instead.
Follow [SECURITY.md](https://github.com/cloudzero/template-cloudzero-open-source/blob/main/SECURITY.md)
(GitHub private reporting or security@cloudzero.com).

Thank you for helping us improve this project! Please fill out the following information.

Expand Down Expand Up @@ -65,14 +66,14 @@ body:
attributes:
label: Platform/Framework Version
description: What platform or framework version are you using?
placeholder: "e.g., Python 3.11, Node.js 20"
placeholder: "e.g., Python 3.13, Node.js 24"

- type: input
id: os
attributes:
label: Operating System
description: What operating system are you using?
placeholder: "e.g., Ubuntu 22.04, macOS 14, Windows 11"
placeholder: "e.g., Ubuntu 24.04, macOS 15, Windows 11"

- type: input
id: cloud
Expand Down Expand Up @@ -100,7 +101,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/main/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Report a security vulnerability
url: https://github.com/cloudzero/template-cloudzero-open-source/security/advisories/new
about: Do not file public issues for security reports. Use private reporting.
- name: CloudZero Support
url: mailto:support@cloudzero.com
about: For usage questions and general support
- name: CloudZero Documentation
url: https://docs.cloudzero.com/
about: Check our documentation for guides and references
about: Guides and references on docs.cloudzero.com
30 changes: 20 additions & 10 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,34 @@ labels: ''
assignees: ''

---
**Please do not report security vulnerabilities here**. Please disclose all security issues to [security@cloudzero.com](mailto:security@cloudzero.com).

**Thank you in advance for helping us to improve this project!** Please read through the template below and answer all relevant questions. Your additional work here is greatly appreciated and will help us respond as quickly as possible. For general support or usage questions, use [CloudZero Support](mailto:support@cloudzero.com). Finally, to avoid duplicates, please search existing Issues before submitting one here.
# Feature request

By submitting an Issue to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md).
**Please do not report security vulnerabilities here.** Follow
[SECURITY.md](../../SECURITY.md) instead.

### Describe the problem you'd like to have solved
Thank you for helping us improve this project. Fill out the sections below so
we can respond quickly. For usage questions, email
[CloudZero Support](mailto:support@cloudzero.com). Search existing issues
before opening a new one.

> A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
By submitting an issue you agree to the
[CloudZero Code of Conduct](../../CODE-OF-CONDUCT.md).

### Describe the ideal solution
## Describe the problem you'd like to have solved

> A clear and concise description of what the problem is. For example: I'm
> always frustrated when [...]

## Describe the ideal solution

> A clear and concise description of what you want to happen.

## Alternatives and current work-arounds
## Alternatives and current workarounds

> A clear and concise description of any alternatives you've considered or any work-arounds that are currently in place.
> A clear and concise description of any alternatives you've considered or
> any workarounds that are currently in place.

### Additional context
## Additional context

> Add any other context or screenshots about the feature request here.
> Add any other context or screenshots about the feature request here.
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ body:
attributes:
value: |
**Please do not report security vulnerabilities here.**
Email [security@cloudzero.com](mailto:security@cloudzero.com) instead.
Follow [SECURITY.md](https://github.com/cloudzero/template-cloudzero-open-source/blob/main/SECURITY.md)
(GitHub private reporting or security@cloudzero.com).

Thank you for helping us improve this project! Please describe your feature request.

Expand Down Expand Up @@ -79,7 +80,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/main/CODE-OF-CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
47 changes: 25 additions & 22 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
By submitting a PR to this repository, you agree to the terms within the [CloudZero Code of Conduct](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CODE-OF-CONDUCT.md). Please see the [contributing guidelines](https://github.com/cloudzero/template-cloudzero-open-source/blob/master/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo.
# Pull request

### Description
By submitting a PR to this repository, you agree to the
[CloudZero Code of Conduct](CODE-OF-CONDUCT.md). See the
[contributing guidelines](CONTRIBUTING.md) for how to create a high-quality PR.

> Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context.
## Description

> Describe the purpose of this PR, any background, and the impact of the
> change. Do not assume prior context.
>
> Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc.
> Include breaking changes, alternatives considered, and API changes.
>
> If the UI is being changed, please provide screenshots.

> If the UI is changing, add screenshots.

### References
## References

> Include any links supporting this change such as a:
> Link supporting context, such as:
>
> - GitHub Issue/PR number addressed or fixed
> - StackOverflow post
> - Support forum thread
> - Related pull requests/issues from other repos
> - A GitHub issue this PR addresses
> - A related discussion or design doc
> - Related pull requests from other repos
>
> If there are no references, simply delete this section.
> If there are no references, delete this section.

### Testing
## Testing

> Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.
>
> Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.
> Tell reviewers how to test the change. Call out anything you did not test
> and why. Add unit or integration tests for new behavior.
>
> Also include details of the environment this PR was developed in (language/platform/browser version).
> Include manual steps for flows that tests do not cover, and the environment
> you used (language, platform, browser).

- [ ] This change adds test coverage for new/changed/fixed functionality
- [ ] This change adds test coverage for new, changed, or fixed functionality

### Checklist
## Checklist

- [ ] I have added documentation for new/changed functionality in this PR
- [ ] I have added documentation for new or changed functionality
- [ ] All active GitHub checks for tests, formatting, and security are passing
- [ ] The correct base branch is being used, if not `main`
- [ ] The correct base branch is being used (`main` unless otherwise required)
32 changes: 29 additions & 3 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Reference: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
# https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference

version: 2
updates:
Expand All @@ -8,18 +8,44 @@ updates:
interval: "weekly"
labels:
- "auto-approve"
- "dependencies"
open-pull-requests-limit: 5
- package-ecosystem: pip
directory: "/"
groups:
github-actions:
patterns:
- "*"

- package-ecosystem: "uv"
directory: "/python"
schedule:
interval: "weekly"
labels:
- "auto-approve"
- "dependencies"
open-pull-requests-limit: 5
groups:
python:
patterns:
- "*"

- package-ecosystem: "npm"
directory: "/javascript"
schedule:
interval: "weekly"
labels:
- "auto-approve"
- "dependencies"
open-pull-requests-limit: 5
groups:
javascript:
patterns:
- "*"

- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
labels:
- "auto-approve"
- "dependencies"
open-pull-requests-limit: 5
1 change: 1 addition & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ changelog:
- fix
- title: 📚 Documentation
labels:
- type: documentation
- documentation
- docs
- title: 🔧 Maintenance
Expand Down
Loading
Loading