Skip to content

Commit 7bb5c83

Browse files
jcook3701jcook3701
authored
Feat 006 (#23)
* feat(docs): Preparing project for Contributor License Agreements and getting major project documentation ready. * chore(update): Update from cookiecutter-cookiecutter using cookiecutter_project_upgrader.
1 parent 173783a commit 7bb5c83

38 files changed

Lines changed: 514 additions & 28 deletions

‎.github/ISSUE_TEMPLATE/01-bug-report.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# 01-bug_report.yml for github-docs-cookiecutter
2+
#
3+
# Copyright (c) 2026, Jared Cook
4+
# SPDX-License-Identifier: GPL-3.0-or-later
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with this program. If not, see <www.gnu.org>.
18+
#
19+
---
20+
name: 🐞 Bug Report
21+
description: File a bug report for this template.
22+
title: "[Bug]: "
23+
labels: ["bug"]
24+
assignees:
25+
- jcook3701
26+
body:
27+
- type: markdown
28+
attributes:
29+
value: |
30+
Thanks for reporting a bug! Please provide as much detail as possible to help us fix it.
31+
- type: textarea
32+
id: what-happened
33+
attributes:
34+
label: What happened?
35+
description: What did you expect to happen vs what actually happened?
36+
placeholder: Describe the error here...
37+
validations:
38+
required: true
39+
- type: dropdown
40+
id: os
41+
attributes:
42+
label: Operating System
43+
description: What OS are you running cookiecutter on?
44+
options:
45+
- Windows
46+
- macOS
47+
- Linux
48+
validations:
49+
required: true
50+
- type: input
51+
id: cc-version
52+
attributes:
53+
label: Cookiecutter Version
54+
description: Run 'cookiecutter --version' and paste the output.
55+
placeholder: e.g. 2.6.0
56+
validations:
57+
required: false
58+
- type: textarea
59+
id: logs
60+
attributes:
61+
label: Relevant log output or Error Message
62+
description: Please copy and paste the traceback or error message here.
63+
render: shell
64+
- type: checkboxes
65+
id: terms
66+
attributes:
67+
label: Acknowledgement
68+
options:
69+
- label: I have checked the existing issues for similar reports.
70+
required: true

‎.github/ISSUE_TEMPLATE/02-feature-request.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# 02-feature-request.yml for github-docs-cookiecutter
2+
#
3+
# Copyright (c) 2026, Jared Cook
4+
# SPDX-License-Identifier: GPL-3.0-or-later
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with this program. If not, see <www.gnu.org>.
18+
#
19+
---
20+
name: 💡 Feature Request
21+
description: Suggest an idea for this cookiecutter template.
22+
title: "[Feature]: "
23+
labels: ["enhancement"]
24+
assignees:
25+
- jcook3701
26+
body:
27+
- type: markdown
28+
attributes:
29+
value: |
30+
Got a great idea for this template? We'd love to hear it!
31+
- type: textarea
32+
id: problem
33+
attributes:
34+
label: Is your feature request related to a problem?
35+
description: A clear and concise description of what the problem is.
36+
placeholder: "Ex. I'm always frustrated when [...]"
37+
validations:
38+
required: true
39+
- type: textarea
40+
id: solution
41+
attributes:
42+
label: Describe the solution you'd like
43+
description: A clear and concise description of what you want to happen.
44+
placeholder: "Ex. It would be great if the template automatically [...]"
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: alternatives
49+
attributes:
50+
label: Describe alternatives you've considered
51+
description: A clear and concise description of any alternative solutions or features you've considered.
52+
- type: textarea
53+
id: context
54+
attributes:
55+
label: Additional context
56+
description: Add any other context or screenshots about the feature request here.
57+
- type: checkboxes
58+
id: contribution
59+
attributes:
60+
label: Contribution
61+
options:
62+
- label: I would be willing to submit a pull request to implement this feature myself!

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ISSUE_TEMPLATE/config.yml.yml for github-docs-cookiecutter
2+
#
3+
# Copyright (c) 2026, Jared Cook
4+
# SPDX-License-Identifier: GPL-3.0-or-later
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with this program. If not, see <www.gnu.org>.
18+
#
19+
---
20+
blank_issues_enabled: false
21+
contact_links:
22+
- name: GitHub Community Support
23+
url: https://github.com/orgs/community/discussions
24+
about: Please ask and answer questions here.
25+
- name: GitHub Security Bug Bounty
26+
url: https://bounty.github.com/
27+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/z-developer-issue.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# z-developer-issue.yml for github-docs-cookiecutter
2+
#
3+
# Copyright (c) 2026, Jared Cook
4+
# SPDX-License-Identifier: GPL-3.0-or-later
5+
#
6+
# This program is free software: you can redistribute it and/or modify
7+
# it under the terms of the GNU General Public License as published by
8+
# the Free Software Foundation, either version 3 of the License, or
9+
# (at your option) any later version.
10+
#
11+
# This program is distributed in the hope that it will be useful,
12+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14+
# GNU General Public License for more details.
15+
#
16+
# You should have received a copy of the GNU General Public License
17+
# along with this program. If not, see <www.gnu.org>.
18+
#
19+
---
20+
name: "🛠️ Developer / General Issue"
21+
description: "Blank template for contributors and maintainers (no form)."
22+
title: "[Dev]: "
23+
labels: ["internal"]
24+
assignees:
25+
- jcook3701
26+
body:
27+
- type: textarea
28+
id: content
29+
attributes:
30+
label: Issue Content
31+
description: "Free-form text area for developer tasks, refactoring, or general notes."
32+
placeholder: "Describe the task or internal update..."
33+
validations:
34+
required: true

‎.github/workflows/dependency-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# dependency-check.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

‎.github/workflows/format-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# black-format.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

‎.github/workflows/jekyll-gh-pages.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# jekyll-gh-pages.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

‎.github/workflows/lint-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# lint-check.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

‎.github/workflows/security-audit.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# security-audit.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

‎.github/workflows/spellcheck.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# spellcheck.yml for github-docs-cookiecutter
22
#
3-
# Copyright (c) 2025, Jared Cook
3+
# Copyright (c) 2026, Jared Cook
44
# SPDX-License-Identifier: GPL-3.0-or-later
55
#
66
# This program is free software: you can redistribute it and/or modify

0 commit comments

Comments
 (0)