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
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ==============================================================================
# EditorConfig for project_name
# EditorConfig for gitversioned
# https://editorconfig.org
#
# This file enforces consistent coding styles across multiple editors and IDEs.
Expand Down
6 changes: 3 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
APP_ENV=development
# Enable/disable debug mode (verbose logging, stack traces)
APP_DEBUG=true
APP_NAME="project_name"
APP_NAME="gitversioned"
APP_VERSION="1.0.0"
# Base URL for the application (useful for generating absolute links, emails)
APP_URL=http://localhost:8080
Expand All @@ -42,13 +42,13 @@ CORS_ALLOWED_ORIGINS=http://localhost:3000,http://localhost:8080
DB_CONNECTION=postgres
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=project_name_dev
DB_DATABASE=gitversioned_dev
DB_USERNAME=admin
DB_PASSWORD=secret
# Database schema (if applicable, e.g., public for postgres)
DB_SCHEMA=public
# Full connection string alternative (often used by ORMs like Prisma or SQLAlchemy)
# DATABASE_URL=postgres://admin:secret@localhost:5432/project_name_dev
# DATABASE_URL=postgres://admin:secret@localhost:5432/gitversioned_dev

# ------------------------------------------------------------------------------
# Cache / Key-Value Store / Message Brokers
Expand Down
26 changes: 13 additions & 13 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -19,46 +19,46 @@
# Catches all files not matched by a more specific rule below.
# This team or user is the reviewer of last resort.
# -----------------------------------------------------------------------------
* @{{maintainer_username}}
* @markurtz

# -----------------------------------------------------------------------------
# CI/CD & Infrastructure
# Requires review from a platform/infrastructure team for any workflow changes.
# -----------------------------------------------------------------------------
.github/ @{{maintainer_username}}
.github/workflows/ @{{maintainer_username}}
.github/ @markurtz
.github/workflows/ @markurtz

# -----------------------------------------------------------------------------
# Documentation
# Route docs changes to the team responsible for content quality.
# -----------------------------------------------------------------------------
docs/ @{{maintainer_username}}
*.md @{{maintainer_username}}
mkdocs.yml @{{maintainer_username}}
docs/ @markurtz
*.md @markurtz
mkdocs.yml @markurtz

# -----------------------------------------------------------------------------
# Security-Sensitive Files
# Any change to security policy, secrets config, or dependencies must be
# reviewed by the security team.
# -----------------------------------------------------------------------------
SECURITY.md @{{maintainer_username}}
.github/dependabot.yml @{{maintainer_username}}
.pre-commit-config.yaml @{{maintainer_username}}
SECURITY.md @markurtz
.github/dependabot.yml @markurtz
.pre-commit-config.yaml @markurtz

# -----------------------------------------------------------------------------
# Core Source Code
# Replace with the path to your primary package directory.
# -----------------------------------------------------------------------------
src/ @{{maintainer_username}}
src/ @markurtz

# -----------------------------------------------------------------------------
# Tests
# Requires review from someone responsible for test quality and coverage.
# -----------------------------------------------------------------------------
tests/ @{{maintainer_username}}
tests/ @markurtz

# -----------------------------------------------------------------------------
# Container & Deployment
# -----------------------------------------------------------------------------
Dockerfile @{{maintainer_username}}
docker-compose.yml @{{maintainer_username}}
Dockerfile @markurtz
docker-compose.yml @markurtz
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
name: 🐛 Bug Report
description: Create a report to help us improve project_name
description: Create a report to help us improve gitversioned
labels:
- "bug"
- "triage"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug to `project_name`!
Thanks for taking the time to report a bug to `gitversioned`!
> [!IMPORTANT]
> If you have found a **security vulnerability**, please refer to our [Security Policy](../SECURITY.md) and do not open a public issue.
For general help and Q&A, please use [GitHub Discussions](https://github.com/{{organization}}/project_name/discussions) instead.
For general help and Q&A, please use [GitHub Discussions](https://github.com/markurtz/git-versioned/discussions) instead.
- type: checkboxes
id: checks
attributes:
label: Search before asking
description: Please confirm that you have checked the following before submitting your
bug report.
options:
- label: I have searched the [existing issues](https://github.com/{{organization}}/project_name/issues)
- label: I have searched the [existing issues](https://github.com/markurtz/git-versioned/issues)
and could not find a similar bug.
required: true
- label: I have read the [Official Documentation](https://{{organization}}.github.io/project_name).
- label: I have read the [Official Documentation](https://markurtz.github.io/git-versioned).
required: true
- type: textarea
id: description
Expand Down Expand Up @@ -60,7 +60,7 @@ body:
value: |
- OS (e.g., Linux, macOS, Windows):
- Language Version (e.g., Python 3.10):
- `project_name` Version:
- `gitversioned` Version:
- Other relevant dependency versions:
validations:
required: true
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
name: Feature Request
description: Suggest an idea for project_name
description: Suggest an idea for gitversioned
labels:
- "enhancement"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest a feature for project_name!
Before submitting, please ensure you have searched our existing [Issues](https://github.com/{{organization}}/project_name/issues) and [Discussions](https://github.com/{{organization}}/project_name/discussions) to see if this feature has already been requested.
Thanks for taking the time to suggest a feature for gitversioned!
Before submitting, please ensure you have searched our existing [Issues](https://github.com/markurtz/git-versioned/issues) and [Discussions](https://github.com/markurtz/git-versioned/discussions) to see if this feature has already been requested.
- type: textarea
id: problem
attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Thanks for contributing to project_name!
Thanks for contributing to GitVersioned!
Please review the [Contributing Guidelines](../CONTRIBUTING.md) before submitting your PR.
-->

Expand Down Expand Up @@ -57,11 +57,11 @@ please add screenshots, terminal output, or recordings to demonstrate the change
## Checklist

> [!IMPORTANT]
> Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of `project_name`.
> Please review and complete this checklist before submitting your PR. This helps our maintainers process your contribution faster and ensures it meets the quality standards of `gitversioned`.

- [ ] "I certify that all code in this PR is my own, except as noted below."
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guide.
- [ ] My code follows the established style guidelines of `project_name`.
- [ ] My code follows the established style guidelines of `gitversioned`.
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
Expand Down
72 changes: 27 additions & 45 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
#
# Supported ecosystems:
# • github-actions — workflow action version pins
# • pip — Python packages (uncomment if applicable)
# • npm — Node.js packages (uncomment if applicable)
# • docker — Base image tags (uncomment if applicable)
# • pip — Python packages
# • docker — Base image tags
#
# After PRs are opened, weekly.yml surfaces them via Slack for human review.
# =============================================================================
Expand All @@ -33,10 +32,10 @@ updates:
- "github-actions"
commit-message:
prefix: "chore(actions)"
# TODO: Add at least one reviewer here! Without an assigned reviewer,
# Dependabot PRs often rot in the queue and are ignored.
reviewers: [] # e.g., ["maintainer1", "org/platform-team"]
assignees: [] # e.g., ["maintainer1"]
reviewers:
- "markurtz"
assignees:
- "markurtz"
open-pull-requests-limit: 5

# ── Python (pip) ────────────────────────────────────────────────────────────
Expand All @@ -56,44 +55,27 @@ updates:
- "python"
commit-message:
prefix: "chore(deps)"
reviewers:
- "markurtz"
assignees:
- "markurtz"
open-pull-requests-limit: 5

# ── Node.js (npm) ────────────────────────────────────────────────────────────
# Uncomment when this repository contains a package.json.
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# day: "monday"
# time: "09:00"
# timezone: "America/New_York"
# groups:
# npm-dependencies:
# update-types:
# - "minor"
# - "patch"
# npm-major-dependencies:
# update-types:
# - "major"
# labels:
# - "dependencies"
# - "javascript"
# commit-message:
# prefix: "chore(deps)"
# open-pull-requests-limit: 5

# ── Docker ───────────────────────────────────────────────────────────────────
# Uncomment to receive PRs for Dockerfile base image updates.
# - package-ecosystem: "docker"
# directory: "/"
# schedule:
# interval: "weekly"
# day: "monday"
# time: "09:00"
# timezone: "America/New_York"
# labels:
# - "dependencies"
# - "docker"
# commit-message:
# prefix: "chore(docker)"
# open-pull-requests-limit: 3
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
day: "monday"
time: "09:00"
timezone: "America/New_York"
labels:
- "dependencies"
- "docker"
commit-message:
prefix: "chore(docker)"
reviewers:
- "markurtz"
assignees:
- "markurtz"
open-pull-requests-limit: 3
4 changes: 1 addition & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Project Context

**`project_name`** is a production-ready Apache 2.0 template repository for bootstrapping modern software projects.
**`gitversioned`** is an opinionated PEP 440 Python versioning tool for Git repos and submodules.
**Primary language:** `Python 3.10+`\
**Package manager:** `Hatch`

Expand All @@ -17,7 +17,6 @@
> 1. **Do not modify `LICENSE` or `NOTICE`.** These are legally binding.
> 1. **Do not modify workflow trigger conditions** without human review.
> 1. **All new source files must include the Apache 2.0 copyright header.**
> 1. **Use `{{double_braces}}` for template placeholders.** Never hard-code them.

## Repository Layout

Expand Down Expand Up @@ -54,7 +53,6 @@

- **`docs/`** and **`mkdocs.yml`** control the site. Do not create docs outside the `nav:` tree.
- `docs/index.md` dynamically includes `README.md` via MkDocs snippets.
- Use `{{placeholder}}` variables for templated fields (e.g., `project_name`, `{{organization}}`).

## Agent Notes

Expand Down
16 changes: 5 additions & 11 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@
# This CITATION.cff file was generated from a template.
# Update the placeholders below with your project's specific details.
# Citation metadata for GitVersioned.
# For more information on the CFF format, see: https://citation-file-format.github.io/

cff-version: 1.2.0
title: "project_name"
title: "GitVersioned"
message: "If you use this software, please cite it as below."
type: software
version: "{{version}}"
date-released: "{{date_released}}"
license: Apache-2.0

# You can list individual authors or an organization.
# This defaults to the organization to match the README's BibTeX.
authors:
- name: "{{organization}}"
# - family-names: "{{author_family_name}}"
# given-names: "{{author_given_name}}"
# orcid: "https://orcid.org/{{orcid}}"
- name: "Mark Kurtz"

repository-code: "https://github.com/{{organization}}/project_name"
url: "https://{{organization}}.github.io/project_name"
repository-code: "https://github.com/markurtz/git-versioned"
url: "https://markurtz.github.io/git-versioned"
4 changes: 2 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct for `project_name`
# Code of Conduct for GitVersioned

## Our Pledge

Expand Down Expand Up @@ -61,7 +61,7 @@ representative at an online or offline event.
> [!IMPORTANT]
> Instances of abusive, harassing, or otherwise unacceptable behavior may be
> reported to the community leaders responsible for enforcement by contacting
> **conduct@{{organization}}.com**.
> **conduct@markurtz.com**.

All complaints will be reviewed and investigated promptly and fairly.

Expand Down
Loading
Loading