Skip to content
Open
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
15 changes: 15 additions & 0 deletions project_template/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true

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

[*.{yml,yaml,json,toml}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false
60 changes: 60 additions & 0 deletions project_template/.github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug Report
description: Report a bug in {{ project_name }}
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug. Please fill in the details below.

- type: textarea
id: description
attributes:
label: Description
description: A clear description of what the bug is.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Steps to reproduce the behaviour.
placeholder: |
1. Install ...
2. Run ...
3. See error ...
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behaviour
description: What you expected to happen.
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behaviour
description: What actually happened.
validations:
required: true

- type: input
id: python-version
attributes:
label: Python version
placeholder: "3.12"
validations:
required: true

- type: input
id: os
attributes:
label: Operating system
placeholder: "Ubuntu 22.04 / macOS 14 / Windows 11"
validations:
required: true
32 changes: 32 additions & 0 deletions project_template/.github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature Request
description: Suggest a new feature for {{ project_name }}
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please fill in the details below.

- type: textarea
id: description
attributes:
label: Description
description: A clear description of the feature you'd like.
validations:
required: true

- type: textarea
id: motivation
attributes:
label: Motivation
description: Why is this feature needed? What problem does it solve?
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed solution
description: How do you think this could be implemented?
validations:
required: false
13 changes: 13 additions & 0 deletions project_template/.github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
groups:
dev-dependencies:
dependency-type: "development"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
11 changes: 11 additions & 0 deletions project_template/.github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Summary

<!-- Brief description of what this PR does -->

## Checklist

- [ ] Tests pass (`uv run pytest`)
- [ ] Linting passes (`uv run ruff check . && uv run ruff format --check .`)
- [ ] Type checking passes (`uvx ty check`)
- [ ] Docs build (`uv run mkdocs build --strict`) if applicable
- [ ] `uv.lock` is up to date
Loading