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
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# 01-bug_report.yml for github-docs-cookiecutter
#
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <www.gnu.org>.
#
---
name: 🐞 Bug Report
description: File a bug report for this template.
title: "[Bug]: "
labels: ["bug"]
assignees:
- jcook3701
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please provide as much detail as possible to help us fix it.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What did you expect to happen vs what actually happened?
placeholder: Describe the error here...
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: What OS are you running cookiecutter on?
options:
- Windows
- macOS
- Linux
validations:
required: true
- type: input
id: cc-version
attributes:
label: Cookiecutter Version
description: Run 'cookiecutter --version' and paste the output.
placeholder: e.g. 2.6.0
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output or Error Message
description: Please copy and paste the traceback or error message here.
render: shell
- type: checkboxes
id: terms
attributes:
label: Acknowledgement
options:
- label: I have checked the existing issues for similar reports.
required: true
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 02-feature-request.yml for github-docs-cookiecutter
#
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <www.gnu.org>.
#
---
name: 💡 Feature Request
description: Suggest an idea for this cookiecutter template.
title: "[Feature]: "
labels: ["enhancement"]
assignees:
- jcook3701
body:
- type: markdown
attributes:
value: |
Got a great idea for this template? We'd love to hear it!
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
placeholder: "Ex. I'm always frustrated when [...]"
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: "Ex. It would be great if the template automatically [...]"
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: contribution
attributes:
label: Contribution
options:
- label: I would be willing to submit a pull request to implement this feature myself!
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ISSUE_TEMPLATE/config.yml.yml for github-docs-cookiecutter
#
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <www.gnu.org>.
#
---
blank_issues_enabled: false
contact_links:
- name: GitHub Community Support
url: https://github.com/orgs/community/discussions
about: Please ask and answer questions here.
- name: GitHub Security Bug Bounty
url: https://bounty.github.com/
about: Please report security vulnerabilities here.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/z-developer-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# z-developer-issue.yml for github-docs-cookiecutter
#
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <www.gnu.org>.
#
---
name: "🛠️ Developer / General Issue"
description: "Blank template for contributors and maintainers (no form)."
title: "[Dev]: "
labels: ["internal"]
assignees:
- jcook3701
body:
- type: textarea
id: content
attributes:
label: Issue Content
description: "Free-form text area for developer tasks, refactoring, or general notes."
placeholder: "Describe the task or internal update..."
validations:
required: true
2 changes: 1 addition & 1 deletion .github/workflows/dependency-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# dependency-check.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/format-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# black-format.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/jekyll-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# jekyll-gh-pages.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# lint-check.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/security-audit.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# security-audit.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# spellcheck.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# tests.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/typecheck.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# typecheck.yml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# .gitignore for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down
56 changes: 56 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# .markdownlint.yaml for github-docs-cookiecutter
#
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <www.gnu.org>.
#
---
# Enable all built-in rules by default
default: true

# MD007/ul-indent: Set unordered list indentation to 2 spaces
MD007:
indent: 2

# MD013/line-length: Disable or adjust long line warnings
# Many developers disable this to allow long URLs or technical prose
MD013: false

# MD022/blanks-around-headings: Headings should be surrounded by blank lines
# Disabling this allows headings to be immediately preceded or followed by text
MD022: false

# MD024/no-duplicate-heading: Allow duplicate headings if they are not siblings
MD024:
siblings_only: true

# MD029/ol-prefix: Use 1. 2. 3. for ordered lists (default is "one" i.e., 1. 1. 1.)
MD029:
style: "ordered"

# MD032/blanks-around-lists: Lists should be surrounded by blank lines
# Setting this to false ignores the rule entirely
MD032: false

# MD033/no-inline-html: Allow specific HTML tags if needed
MD033:
allowed_elements: ["br", "details", "summary"]

# MD041/first-line-h1: Ensure the file starts with a top-level heading
MD041: true

# MD046/code-block-style: Enforce fenced code blocks (```)
MD046:
style: "fenced"
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pre-commit-config.yaml for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand Down Expand Up @@ -31,11 +31,11 @@
- id: mixed-line-ending
args: [--fix=lf]
- id: check-yaml
exclude: '{{ cookiecutter.project_slug }}/.*'

Check warning on line 34 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

34:18 [quoted-strings] string value is not quoted with double quotes

Check warning on line 34 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

34:18 [quoted-strings] string value is not quoted with double quotes
- id: check-json
exclude: '{{ cookiecutter.project_slug }}/.*'

Check warning on line 36 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

36:18 [quoted-strings] string value is not quoted with double quotes

Check warning on line 36 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

36:18 [quoted-strings] string value is not quoted with double quotes
- id: check-toml
exclude: '{{ cookiecutter.project_slug }}/.*'

Check warning on line 38 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

38:18 [quoted-strings] string value is not quoted with double quotes

Check warning on line 38 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

38:18 [quoted-strings] string value is not quoted with double quotes
- id: detect-private-key
- id: check-case-conflict
- id: check-added-large-files
Expand All @@ -45,7 +45,7 @@
rev: 25.11.0
hooks:
- id: black
exclude: '{{ cookiecutter.project_slug }}/.*'

Check warning on line 48 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

48:18 [quoted-strings] string value is not quoted with double quotes

Check warning on line 48 in .pre-commit-config.yaml

View workflow job for this annotation

GitHub Actions / jinja2-lint

48:18 [quoted-strings] string value is not quoted with double quotes

- repo: local
hooks:
Expand Down
2 changes: 1 addition & 1 deletion .yamllint
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# .yamllint for github-docs-cookiecutter
#
# Copyright (c) 2025, Jared Cook
# Copyright (c) 2026, Jared Cook
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
Expand All @@ -21,7 +21,7 @@
ignore:
- .venv
- changelogs
- '{{ cookiecutter.project_slug }}'

Check warning on line 24 in .yamllint

View workflow job for this annotation

GitHub Actions / jinja2-lint

24:5 [quoted-strings] string value is not quoted with double quotes

Check warning on line 24 in .yamllint

View workflow job for this annotation

GitHub Actions / jinja2-lint

24:5 [quoted-strings] string value is not quoted with double quotes

rules:
line-length:
Expand Down
Loading