From 7c1f1298c61e6ff393c6d0bf44f4dde87886ae5a Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Mon, 26 Jan 2026 18:03:57 -0800 Subject: [PATCH 01/11] Update template --- .cookiecutter_includes/gitignore.j2 | 1 + .cookiecutter_includes/license/0bsd.j2 | 3 + .cookiecutter_includes/license/__init__.j2 | 2 + .cookiecutter_includes/license/agpl-3.0.j2 | 3 + .cookiecutter_includes/license/apache-2.0.j2 | 5 + .../license/bsd-2-clause.j2 | 2 + .../license/bsd-3-clause.j2 | 2 + .cookiecutter_includes/license/gpl-3.0.j2 | 3 + .../license/license-data.j2 | 2 + .../license/license-header.j2 | 1 + .cookiecutter_includes/license/license.j2 | 2 + .cookiecutter_includes/license/mit.j2 | 3 + .cookiecutter_includes/license/unlicense.j2 | 3 + .cookiecutter_includes/make/__init__.j2 | 2 + .cookiecutter_includes/make/clean.j2 | 1 + .cookiecutter_includes/make/docs.j2 | 1 + .cookiecutter_includes/make/help.j2 | 2 + .cookiecutter_includes/make/lint.j2 | 0 .cookiecutter_includes/make/phony.j2 | 1 + .cookiecutter_includes/make/python.j2 | 0 .cookiecutter_includes/make/settings.j2 | 1 + .cookiecutter_includes/make/version.j2 | 1 + .cookiecutter_includes/pyproject/__init__.j2 | 0 .cookiecutter_includes/tests/__init__.j2 | 2 + .cookiecutter_includes/tests/bake.j2 | 2 + .gitattributes | 5 + .github/CODEOWNERS | 2 + .github/CONTRIBUTING.md | 124 ++++ .github/FUNDING.yml | 5 + .github/ISSUE_TEMPLATE/01-bug-report.yml | 69 ++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 61 ++ .github/ISSUE_TEMPLATE/config.yml | 26 + .github/ISSUE_TEMPLATE/z-developer-issue.yml | 33 + .../01-default-pull-request.md | 24 + .github/PULL_REQUEST_TEMPLATE/02-bug-fix.md | 20 + .../03-feature-request.md | 21 + .github/SECURITY.md | 13 + .github/pull_request_template.md | 5 + .github/workflows/cla.yml | 64 ++ .github/workflows/dependency-check.yml | 42 ++ .github/workflows/format-check.yml | 42 ++ .github/workflows/jekyll-gh-pages.yml | 86 +++ .github/workflows/lint-check.yml | 55 ++ .github/workflows/security-audit.yml | 42 ++ .github/workflows/spellcheck.yml | 42 ++ .github/workflows/tests.yml | 42 ++ .github/workflows/typecheck.yml | 42 ++ .gitignore | 86 +++ .jinja-runtime.json | 18 + .markdownlint.yaml | 63 ++ .pre-commit-config.yaml | 79 +++ .yamllint | 53 ++ LICENSE.md | 660 ++++++++++++++++++ Makefile | 544 +++++++++++++++ README.md | 1 - cliff.toml | 86 +++ cookiecutter.json | 56 ++ cspell.json | 59 ++ docs/cookiecutter_input.json | 65 ++ docs/jekyll/.gitignore | 74 ++ .../appspecific/com.chrome.devtools.json | 1 + docs/jekyll/Gemfile | 16 + docs/jekyll/Makefile | 96 +++ docs/jekyll/README.md | 34 + docs/jekyll/_config.yml | 164 +++++ docs/jekyll/_includes/image-carousel.html | 64 ++ docs/jekyll/_includes/snippet_loader.html | 4 + docs/jekyll/_includes/social-bar.html | 167 +++++ .../contribute/create-feature-request.md | 59 ++ .../_manual/contribute/create-pull-request.md | 18 + .../_manual/contribute/developer-guide.md | 82 +++ .../_manual/contribute/git-commit-message.md | 25 + docs/jekyll/_manual/contribute/index.md | 17 + .../_manual/contribute/merge-pull-request.md | 61 ++ .../_manual/contribute/style-guides/index.md | 11 + .../_manual/contribute/style-guides/python.md | 6 + .../contribute/style-guides/typescript.md | 6 + .../developer-resources/cla-privacy-policy.md | 20 + .../jekyll/_manual/developer-resources/cla.md | 26 + .../_manual/developer-resources/contribute.md | 31 + .../_manual/developer-resources/index.md | 13 + docs/jekyll/_manual/introduction/index.md | 7 + docs/jekyll/_manual/setup-guide/index.md | 7 + .../_manual/setup-guide/requirements.md | 24 + docs/jekyll/_manual/troubleshooting/index.md | 7 + docs/jekyll/_manual/tutorials/index.md | 7 + docs/jekyll/_manual/upgrade-guide/index.md | 13 + docs/jekyll/_manual/whatsnew/index.md | 7 + docs/jekyll/_resources/repository-link.md | 5 + docs/jekyll/docs/cookiecutter_input.json | 43 ++ docs/jekyll/index.md | 24 + hooks/post_gen_project.py | 51 ++ hooks/pre_gen_project.py | 35 + pyproject.toml | 268 +++++++ tests/test_bake_project.py | 44 ++ 95 files changed, 4216 insertions(+), 1 deletion(-) create mode 100644 .cookiecutter_includes/gitignore.j2 create mode 100644 .cookiecutter_includes/license/0bsd.j2 create mode 100644 .cookiecutter_includes/license/__init__.j2 create mode 100644 .cookiecutter_includes/license/agpl-3.0.j2 create mode 100644 .cookiecutter_includes/license/apache-2.0.j2 create mode 100644 .cookiecutter_includes/license/bsd-2-clause.j2 create mode 100644 .cookiecutter_includes/license/bsd-3-clause.j2 create mode 100644 .cookiecutter_includes/license/gpl-3.0.j2 create mode 100644 .cookiecutter_includes/license/license-data.j2 create mode 100644 .cookiecutter_includes/license/license-header.j2 create mode 100644 .cookiecutter_includes/license/license.j2 create mode 100644 .cookiecutter_includes/license/mit.j2 create mode 100644 .cookiecutter_includes/license/unlicense.j2 create mode 100644 .cookiecutter_includes/make/__init__.j2 create mode 100644 .cookiecutter_includes/make/clean.j2 create mode 100644 .cookiecutter_includes/make/docs.j2 create mode 100644 .cookiecutter_includes/make/help.j2 create mode 100644 .cookiecutter_includes/make/lint.j2 create mode 100644 .cookiecutter_includes/make/phony.j2 create mode 100644 .cookiecutter_includes/make/python.j2 create mode 100644 .cookiecutter_includes/make/settings.j2 create mode 100644 .cookiecutter_includes/make/version.j2 create mode 100644 .cookiecutter_includes/pyproject/__init__.j2 create mode 100644 .cookiecutter_includes/tests/__init__.j2 create mode 100644 .cookiecutter_includes/tests/bake.j2 create mode 100644 .gitattributes create mode 100644 .github/CODEOWNERS create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/z-developer-issue.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/02-bug-fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/03-feature-request.md create mode 100644 .github/SECURITY.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/cla.yml create mode 100644 .github/workflows/dependency-check.yml create mode 100644 .github/workflows/format-check.yml create mode 100644 .github/workflows/jekyll-gh-pages.yml create mode 100644 .github/workflows/lint-check.yml create mode 100644 .github/workflows/security-audit.yml create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .github/workflows/tests.yml create mode 100644 .github/workflows/typecheck.yml create mode 100644 .gitignore create mode 100644 .jinja-runtime.json create mode 100644 .markdownlint.yaml create mode 100644 .pre-commit-config.yaml create mode 100644 .yamllint create mode 100644 LICENSE.md create mode 100644 Makefile delete mode 100644 README.md create mode 100644 cliff.toml create mode 100644 cookiecutter.json create mode 100644 cspell.json create mode 100644 docs/cookiecutter_input.json create mode 100644 docs/jekyll/.gitignore create mode 100644 docs/jekyll/.well-known/appspecific/com.chrome.devtools.json create mode 100755 docs/jekyll/Gemfile create mode 100644 docs/jekyll/Makefile create mode 100644 docs/jekyll/README.md create mode 100755 docs/jekyll/_config.yml create mode 100644 docs/jekyll/_includes/image-carousel.html create mode 100644 docs/jekyll/_includes/snippet_loader.html create mode 100644 docs/jekyll/_includes/social-bar.html create mode 100644 docs/jekyll/_manual/contribute/create-feature-request.md create mode 100644 docs/jekyll/_manual/contribute/create-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/developer-guide.md create mode 100644 docs/jekyll/_manual/contribute/git-commit-message.md create mode 100644 docs/jekyll/_manual/contribute/index.md create mode 100644 docs/jekyll/_manual/contribute/merge-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/index.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/python.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/typescript.md create mode 100644 docs/jekyll/_manual/developer-resources/cla-privacy-policy.md create mode 100644 docs/jekyll/_manual/developer-resources/cla.md create mode 100644 docs/jekyll/_manual/developer-resources/contribute.md create mode 100644 docs/jekyll/_manual/developer-resources/index.md create mode 100644 docs/jekyll/_manual/introduction/index.md create mode 100644 docs/jekyll/_manual/setup-guide/index.md create mode 100644 docs/jekyll/_manual/setup-guide/requirements.md create mode 100644 docs/jekyll/_manual/troubleshooting/index.md create mode 100644 docs/jekyll/_manual/tutorials/index.md create mode 100644 docs/jekyll/_manual/upgrade-guide/index.md create mode 100644 docs/jekyll/_manual/whatsnew/index.md create mode 100644 docs/jekyll/_resources/repository-link.md create mode 100644 docs/jekyll/docs/cookiecutter_input.json create mode 100644 docs/jekyll/index.md create mode 100644 hooks/post_gen_project.py create mode 100644 hooks/pre_gen_project.py create mode 100644 pyproject.toml create mode 100644 tests/test_bake_project.py diff --git a/.cookiecutter_includes/gitignore.j2 b/.cookiecutter_includes/gitignore.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/gitignore.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/license/0bsd.j2 b/.cookiecutter_includes/license/0bsd.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/license/0bsd.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/license/__init__.j2 b/.cookiecutter_includes/license/__init__.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/license/__init__.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/license/agpl-3.0.j2 b/.cookiecutter_includes/license/agpl-3.0.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/license/agpl-3.0.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/license/apache-2.0.j2 b/.cookiecutter_includes/license/apache-2.0.j2 new file mode 100644 index 0000000..3f2ff2d --- /dev/null +++ b/.cookiecutter_includes/license/apache-2.0.j2 @@ -0,0 +1,5 @@ + + + + + diff --git a/.cookiecutter_includes/license/bsd-2-clause.j2 b/.cookiecutter_includes/license/bsd-2-clause.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/license/bsd-2-clause.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/license/bsd-3-clause.j2 b/.cookiecutter_includes/license/bsd-3-clause.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/license/bsd-3-clause.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/license/gpl-3.0.j2 b/.cookiecutter_includes/license/gpl-3.0.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/license/gpl-3.0.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/license/license-data.j2 b/.cookiecutter_includes/license/license-data.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/license/license-data.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/license/license-header.j2 b/.cookiecutter_includes/license/license-header.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/license/license-header.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/license/license.j2 b/.cookiecutter_includes/license/license.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/license/license.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/license/mit.j2 b/.cookiecutter_includes/license/mit.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/license/mit.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/license/unlicense.j2 b/.cookiecutter_includes/license/unlicense.j2 new file mode 100644 index 0000000..b28b04f --- /dev/null +++ b/.cookiecutter_includes/license/unlicense.j2 @@ -0,0 +1,3 @@ + + + diff --git a/.cookiecutter_includes/make/__init__.j2 b/.cookiecutter_includes/make/__init__.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/make/__init__.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/make/clean.j2 b/.cookiecutter_includes/make/clean.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/make/clean.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/make/docs.j2 b/.cookiecutter_includes/make/docs.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/make/docs.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/make/help.j2 b/.cookiecutter_includes/make/help.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/make/help.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/make/lint.j2 b/.cookiecutter_includes/make/lint.j2 new file mode 100644 index 0000000..e69de29 diff --git a/.cookiecutter_includes/make/phony.j2 b/.cookiecutter_includes/make/phony.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/make/phony.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/make/python.j2 b/.cookiecutter_includes/make/python.j2 new file mode 100644 index 0000000..e69de29 diff --git a/.cookiecutter_includes/make/settings.j2 b/.cookiecutter_includes/make/settings.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/make/settings.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/make/version.j2 b/.cookiecutter_includes/make/version.j2 new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.cookiecutter_includes/make/version.j2 @@ -0,0 +1 @@ + diff --git a/.cookiecutter_includes/pyproject/__init__.j2 b/.cookiecutter_includes/pyproject/__init__.j2 new file mode 100644 index 0000000..e69de29 diff --git a/.cookiecutter_includes/tests/__init__.j2 b/.cookiecutter_includes/tests/__init__.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/tests/__init__.j2 @@ -0,0 +1,2 @@ + + diff --git a/.cookiecutter_includes/tests/bake.j2 b/.cookiecutter_includes/tests/bake.j2 new file mode 100644 index 0000000..139597f --- /dev/null +++ b/.cookiecutter_includes/tests/bake.j2 @@ -0,0 +1,2 @@ + + diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..41a876a --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +# ========================================= +# cookiecutter project upgrader attributes # +# ========================================= +cookiecutter.json merge=ours +**/README.md* merge=ours diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..7274f8b --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Global owner for the repository +* @jcook3701 diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..901c61c --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,124 @@ +# Contributing to github-docs-cookiecutter + +You want to contribute to github-docs-cookiecutter? Welcome! Please read this document to understand what you can do: + +* [Help Others](#help-others) +* [Analyze Issues](#analyze-issues) +* [Report an Issue](#report-an-issue) +* [Contribute Code](#contribute-code) + +## Help Others + +You can help github-docs-cookiecutter by helping others who use it and need support. + +## Analyze Issues + +Analyzing issue reports can be a lot of effort. Any help is welcome! +Go to [the GitHub issue tracker](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug"). + +Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix? + +## Report an Issue + +If you find a bug - behavior of github-docs-cookiecutter code contradicting your expectation - you are welcome to report it. +We can only handle well-reported, actual bugs, so please follow the guidelines below. + +Once you have familiarized with the guidelines, you can go to the [GitHub issue tracker for github-docs-cookiecutter](https://github.com/jcook3701/github-docs-cookiecutter/issues/new) to report the issue. + +### Quick Checklist for Bug Reports + +Issue report checklist: +* Real, current bug +* No duplicate +* Reproducible +* Good summary +* Well-documented +* Minimal example +* Use the [bug template](ISSUE_TEMPLATE/01-bug-report.yml) + +### Issue handling process + +When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details. + +An issue that is about a real bug is closed as soon as the fix is committed. + +### Reporting Security Issues + +If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. +Please send the related information to . + +### Usage of Labels + +GitHub offers labels to categorize issues. We defined the following labels so far: + +Labels for issue categories: +* bug: this issue is a bug in the code +* feature: this issue is a request for a new functionality or an enhancement request +* design: this issue relates to the UI or UX design of the tool + +Status of open issues: +* help wanted: the feature request is approved and you are invited to contribute + +Status/resolution of closed issues: +* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided + +The labels can only be set and modified by committers. + +### Issue Reporting Disclaimer + +We want to improve the quality of, github-docs-cookiecutter, and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: github-docs-cookiecutter is Open Source and comes without warranty. + +Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions) + +## Contribute Code + +You are welcome to contribute code to github-docs-cookiecutter in order to fix bugs or to implement new features. + + +There are three important things to know: +1. You must be aware that you need to submit [CLA](/docs/jekyll/_manual/developer-resources/cla.md) in order for your contribution to be accepted. This is common practice in all major Open Source projects. +2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines. +3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of github-docs-cookiecutter and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute). + + + +## Contributor License Agreement (CLA) + +Due to legal reasons, contributors will be asked to accept a CLA before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) +[ICLA] and [CCLA]. + +### Contribution Content Guidelines + +These are some of the rules we try to follow: +* Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully clean +* Use (4)spaces for indentation (except if the modified file consistently uses tabs) +* Use variable naming conventions like in the other files you are seeing (underscore) +* No console.log() - use logging service +* Run all ci/cd code checks and make sure they succeed +* Comment your code where it gets non-trivial +* Keep an eye on performance and memory consumption, properly destroy objects when not used anymore +* Write a unit test +* Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties + +### How to contribute - the Process + +1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue +2. Create a branch forking the github-docs-cookiecutter repository and do your change +3. Commit and push your changes on that branch +4. In the commit message + * Describe the problem you fix with this change. + * Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for example, but not all bugs are that obvious and should be mentioned in the text. + * Describe the technical details of what you changed. It is important to describe the change in a most understandable way so the reviewer is able to verify that the code is behaving as you intend it to. +5. If your change fixes an issue reported at GitHub, add the following line to the commit message: + * ```Fixes #(issueNumber)``` + * Do NOT add a colon after "Fixes" - this prevents automatic closing. +6. Create a Pull Request +7. Follow the link posted by the, github-docs-cookiecutter, project to your pull request and accept it, as described in detail above. +8. Wait for our code review and approval, possibly enhancing your change on request + * Note that the github-docs-cookiecutter developers also have their regular duties, so depending on the required effort for reviewing, testing and clarification this may take a while +9. Once the change has been approved we will inform you in a comment +10. We will close the pull request, feel free to delete the now obsolete branch diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..dd36db4 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,5 @@ +# These are supported funding model platforms +--- + +# github: ["jcook3701"] +buy_me_a_coffee: "jcook3701" diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000..ed1297e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,69 @@ +# 01-bug_report.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +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 diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000..d3722e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -0,0 +1,61 @@ +# 02-feature-request.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +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! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..d304245 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,26 @@ +# ISSUE_TEMPLATE/config.yml.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +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. diff --git a/.github/ISSUE_TEMPLATE/z-developer-issue.yml b/.github/ISSUE_TEMPLATE/z-developer-issue.yml new file mode 100644 index 0000000..7cbe109 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/z-developer-issue.yml @@ -0,0 +1,33 @@ +# z-developer-issue.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +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 diff --git a/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md b/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md new file mode 100644 index 0000000..403d1f6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/01-default-pull-request.md @@ -0,0 +1,24 @@ +## Description + + +## Related Issue + +Fixes # + +## Type of Change +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## How Has This Been Tested? + +- [ ] Unit tests pass locally +- [ ] Manual verification (provide details below) + +## Checklist +- [ ] My code follows the style guidelines of this project +- [ ] 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 +- [ ] My changes generate no new warnings diff --git a/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md new file mode 100644 index 0000000..1fa1f3a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/02-bug-fix.md @@ -0,0 +1,20 @@ +## ๐Ÿž Bug Fix Description + + +**Related Issue:** Fixes # + +### ๐Ÿ› ๏ธ Changes Made +- [ ] List specific changes or files modified. +- [ ] Describe how the fix addresses the root cause. + +### ๐Ÿงช How to Reproduce & Test +1. **Steps to reproduce:** (e.g., click X, then Y) +2. **Current behavior:** (before this fix) +3. **Expected behavior:** (after this fix) +4. **Testing performed:** (e.g., ran `pytest` or actions performed to recreate live testing situation) + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have performed a self-review of my code. +- [ ] I have added tests that prove my fix is effective. +- [ ] All new and existing tests passed. diff --git a/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md b/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md new file mode 100644 index 0000000..0301212 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/03-feature-request.md @@ -0,0 +1,21 @@ +## โœจ New Feature Description + + +**Related Issue:** Resolves # + +### ๐Ÿš€ Proposed Changes +- [ ] Detail the new components, logic, or UI added. +- [ ] Mention any new dependencies introduced. + +### ๐Ÿ“ธ Screenshots / Demos (If Applicable) + + +### ๐Ÿ› ๏ธ Technical Details +- [ ] Architecture changes (if any). +- [ ] New environment variables or configurations required. + +### โœ… Checklist +- [ ] My code follows the project style guidelines. +- [ ] I have updated the documentation accordingly. +- [ ] I have added/updated tests for this feature. +- [ ] My changes generate no new warnings or console errors. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..c2ee1c1 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,13 @@ +# Security Vulnerabilities + +The github-docs-cookiecutter project is built with security and data privacy in mind to ensure your data is safe. + +## Reporting +We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline. + +__Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.__ + +For reporting a vulnerability, please send an email directly to . Please address questions about data privacy, security concepts, and other media requests for Security Researchers on our team. + +## Disclosure Handling +We are committed to timely review and respond to your request. The resolution of code defects will be handled by a dedicated group of security experts and prepared in a private GitHub repository. The project will inform the public about resolved security vulnerabilities via GitHub Security Advisories. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8123ec5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,5 @@ +### ๐Ÿ“‹ Select a Pull Request Template +Please switch to the **Preview** tab and select the correct type: +* [Standard PR](?template=01-default-pull-request.md) +* [Bug Fix](?template=02-bug-fix.md) +* [Feature Request](?template=03-feature-request.md) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml new file mode 100644 index 0000000..b479e9d --- /dev/null +++ b/.github/workflows/cla.yml @@ -0,0 +1,64 @@ +# cla.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: "CLA Assistant" +on: + issue_comment: + types: [created] + pull_request_target: + types: [ + opened, + closed, + synchronize + ] + +# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings +permissions: + actions: write + contents: write # this can be 'read' if the signatures are in remote repository + pull-requests: write + statuses: write + +jobs: + CLAAssistant: + runs-on: ubuntu-latest + steps: + - name: "CLA Assistant" + if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' + uses: contributor-assistant/github-action@v2.6.1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # the below token should have repo scope and must be manually added by you in the repository's secret + # This token is required only if you have configured to store the signatures in a remote repository/organization + # PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} with: + signed-commit-message: 'chore: $contributorName has signed the CLA' + path-to-signatures: 'signatures/version1/cla.json' + path-to-document: 'https://github.com/${{ github.repository }}/blob/main/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document + # branch should not be protected + branch: "main" + allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" + + # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken + #remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository) + #remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository) + #create-file-commit-message: 'For example: Creating file for storing CLA Signatures' + #signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo' + #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign' + #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA' + #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.' + #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true) + #use-dco-flag: true - If you are using DCO instead of CLA diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml new file mode 100644 index 0000000..3ecaefd --- /dev/null +++ b/.github/workflows/dependency-check.yml @@ -0,0 +1,42 @@ +# dependency-check.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Dependency Check + +on: [push, pull_request] + +jobs: + dependency-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install deptry + run: | + make python-install + + - name: Run Dependency Check + run: | + make dependency-check diff --git a/.github/workflows/format-check.yml b/.github/workflows/format-check.yml new file mode 100644 index 0000000..148d9bc --- /dev/null +++ b/.github/workflows/format-check.yml @@ -0,0 +1,42 @@ +# black-format.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Format Check + +on: [push, pull_request] + +jobs: + black-format-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Formatting Tools + run: | + make python-install + + - name: Black Format Check + run: | + make black-formatter-check diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml new file mode 100644 index 0000000..eeeab84 --- /dev/null +++ b/.github/workflows/jekyll-gh-pages.yml @@ -0,0 +1,86 @@ +# jekyll-gh-pages.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Deploy Jekyll with GitHub Pages dependencies preinstalled + +on: + push: + branches: + - master + - main + paths: + - "docs/**" + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + - name: Install Python Tools + run: | + make python-install + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.3' # Recommended for Jekyll 4.4 in 2026 + bundler-cache: true # Runs 'bundle install' and caches gems automatically + working-directory: ./docs/jekyll + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Build with Jekyll site in /docs/jekyll + run: make jekyll + env: + PAGES_REPO_NWO: ${{ github.repository }} + JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + JEKYLL_ENV: production + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/jekyll/_site + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/lint-check.yml b/.github/workflows/lint-check.yml new file mode 100644 index 0000000..09468d5 --- /dev/null +++ b/.github/workflows/lint-check.yml @@ -0,0 +1,55 @@ +# lint-check.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Lint Check + +on: [push, pull_request] + +jobs: + jinja2-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install Linting Tools + run: | + make python-install + + - name: Render Cookiecutter Template + run: | + make render-cookiecutter + + - name: Lint Jinja templates + run: | + make djlint-lint-check + - name: Run Ruff Lint Check + run: | + make ruff-lint-check + - name: Run Toml Lint Check + run: | + make toml-lint-check + - name: Run YAML Lint Check + run: | + make yaml-lint-check diff --git a/.github/workflows/security-audit.yml b/.github/workflows/security-audit.yml new file mode 100644 index 0000000..c00ed38 --- /dev/null +++ b/.github/workflows/security-audit.yml @@ -0,0 +1,42 @@ +# security-audit.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Security Audit + +on: [push, pull_request] + +jobs: + security-audit: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pip-audit + run: | + make python-install + + - name: Run Security Check + run: | + make security diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..97435cb --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,42 @@ +# spellcheck.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Spellcheck + +on: [push, pull_request] + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install codespell + run: | + make python-install + + - name: Run Spellcheck + run: | + make spellcheck diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..5ef2e43 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,42 @@ +# tests.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Tests + +on: [push, pull_request] + +jobs: + tests: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install pytest + run: | + make python-install + + - name: Run tests + run: | + make test diff --git a/.github/workflows/typecheck.yml b/.github/workflows/typecheck.yml new file mode 100644 index 0000000..ba49c27 --- /dev/null +++ b/.github/workflows/typecheck.yml @@ -0,0 +1,42 @@ +# typecheck.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +name: Cookiecutter Template Typecheck + +on: [push, pull_request] + +jobs: + typecheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + + - name: Install mypy + run: | + make python-install + + - name: Run typecheck + run: | + make typecheck diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e814f83 --- /dev/null +++ b/.gitignore @@ -0,0 +1,86 @@ +# .gitignore for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# ========================================= +# text editor ignores # +# ========================================= +.vscode/ +# ========================================= +# Python project ignores # +# ========================================= +__pycache__/ +*.egg-info/ +.mypy_cache/ +.pytest_cache/ +.ruff_cache/ +.venv/ +dist/ +# ========================================= +## Default Ignores # +# ========================================= + +# ========================================= +# Backup Extensions # +# ========================================= +*.bak +*.old +*.save +# ========================================= +# Emacs Tmp Extensions # +# ========================================= +*.tmp +*.tmp.* +*.rpmnew +.#* +# ========================================= +# Compiled source Extensions # +# ========================================= +*.com +*.class +*.dll +*.exe +*.o +*.so +# ========================================= +# Package Extensions # +# ========================================= +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip +# ========================================= +# Logs and databases Extensions # +# ========================================= +*.log +*.sql +*.sqlite +# ========================================= +# OS generated files # +# ========================================= +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/.jinja-runtime.json b/.jinja-runtime.json new file mode 100644 index 0000000..4cc19f4 --- /dev/null +++ b/.jinja-runtime.json @@ -0,0 +1,18 @@ +{ + "templates": { + "search_paths": [ + ".", + "./.cookiecutter_includes", + "./github-docs-cookiecutter" + ], + "base_dir": "." + }, + "env": { + "globals": { + "cookiecutter": { + "project_slug": "example_project", + "chosen_license": "MIT" + } + } + } +} diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..056b7ee --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,63 @@ +# .markdownlint.yaml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +# 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 + +# MD014/commands-show-output: Dollar signs used before commands without showing output +# This prevents copy-paste errors by ensuring leading dollar signs are only used when +# output is also present to distinguish them. +MD014: 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" + +# MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank linesmarkdownlintMD031 +MD031: false + +# 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" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d9ede23 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,79 @@ +# pre-commit-config.yaml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +default_install_hook_types: + - pre-commit + - commit-msg + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v6.0.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md, --markdown-linebreak-ext=mdx] + - id: mixed-line-ending + args: [--fix=lf] + - id: check-yaml + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: check-json + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: check-toml + exclude: '{{ cookiecutter.project_slug }}/.*' + - id: detect-private-key + - id: check-case-conflict + - id: check-added-large-files + - id: check-symlinks + + - repo: https://github.com/psf/black + rev: 25.11.0 + hooks: + - id: black + exclude: '{{ cookiecutter.project_slug }}/.*' + + - repo: local + hooks: + - id: generate-changelog + name: Generate CHANGELOG.md + entry: make changelog + language: system + files: CHANGELOG.md + always_run: true + pass_filenames: false + + - repo: local + hooks: + - id: generate-docs + name: Generate Documentation + entry: make build-docs + language: system + always_run: true + pass_filenames: false + + - repo: https://github.com/streetsidesoftware/cspell-cli + rev: v9.3.3 + hooks: + - id: cspell + stages: [commit-msg] + args: ["--config", "./cspell.json"] + + - repo: https://github.com/compilerla/conventional-pre-commit + rev: v4.3.0 + hooks: + - id: conventional-pre-commit + stages: [commit-msg] diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..996f9d8 --- /dev/null +++ b/.yamllint @@ -0,0 +1,53 @@ +# .yamllint for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +--- +extends: default +ignore: + - .venv + - changelogs + - '{{ cookiecutter.project_slug }}' + +rules: + line-length: + max: 120 + level: warning + braces: + min-spaces-inside: 0 + max-spaces-inside: 1 + comments: + # prettier compatibility + min-spaces-from-content: 1 + comments-indentation: false + document-start: + present: true + level: error + key-duplicates: + forbid-duplicated-merge-keys: true + indentation: + level: error + indent-sequences: consistent + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: true + quoted-strings: + quote-type: double + required: false + level: warning + truthy: + allowed-values: + ["true", "false", "yes", "no", "on", "off"] diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c6f01c6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..56c8504 --- /dev/null +++ b/Makefile @@ -0,0 +1,544 @@ +# Makefile for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# -------------------------------------------------- +# โš™๏ธ Environment Settings +# -------------------------------------------------- +SHELL := /bin/bash +.SHELLFLAGS := -O globstar -c +# If V is set to '1' or 'y' on the command line, +# AT will be empty (verbose). Otherwise, AT will +# contain '@' (quiet by default). The '?' is a +# conditional assignment operator: it only sets V +# if it hasn't been set externally. +V ?= 0 +ifeq ($(V),0) + AT = @ +else + AT = +endif +# Detect if we are running inside GitHub Actions CI. +# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. +# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. +ifeq ($(GITHUB_ACTIONS),true) +CI := 1 +else +CI := 0 +endif +# Detect if we are running inside Cookiecutter (pre/post) hooks. +# Cookiecutter hooks are used to set the environment variable COOKIECUTTER_HOOKS=true. +# We set CC=1 if running in Cookiecutter hooks, otherwise CC=0 for standard runs. +COOKIECUTTER_RENDER_DIR := /tmp/rendered +ifeq ($(COOKIECUTTER_HOOKS),true) +CC := 1 +else +CC := 0 +endif +# -------------------------------------------------- +# ๐Ÿ—๏ธ CI/CD Functions +# -------------------------------------------------- +# Returns true when CI is off and gracefully moves through failed checks. +define run_ci_safe = +( $1 || \ + if [ "$(CI)" != "1" ]; then \ + echo "โŒ process finished with error; continuing..."; \ + true; \ + else \ + echo "โŒ process finished with error"; \ + exit 1; \ + fi \ +) +endef +# cc_or_std: +# Selects between Cookiecutter hook context and standard execution context. +# +# If COOKIECUTTER_HOOKS=true, expands to the first argument (Cookiecutter render). +# Otherwise, expands to the second argument (normal project execution). +# +# Usage: +# PROJECT_ROOT := $(call cc_or_std,$(COOKIECUTTER_RENDER_DIR),$(PWD)) +cc_or_std = $(if $(filter true,$(COOKIECUTTER_HOOKS)),$(1),$(2)) +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PROJECT_NAME := "github-docs-cookiecutter" +AUTHOR := "Jared Cook" +VERSION := 0.1.1 +RELEASE := v$(VERSION) +# -------------------------------------------------- +# ๐Ÿ™ Github Build Settings +# -------------------------------------------------- +GITHUB_USER := "jcook3701" +GITHUB_REPO := $(GITHUB_USER)/$(PROJECT_NAME) +# -------------------------------------------------- +# ๐Ÿ“ Build Directories +# -------------------------------------------------- +PROJECT_ROOT := $(call cc_or_std,$(CURDIR),$(PWD)) +HOOKS_DIR := $(PROJECT_ROOT)/hooks +SRC_DIR := $(HOOKS_DIR) +TEST_DIR := $(PROJECT_ROOT)/tests +TESTS_DIR := $(TEST_DIR) +DOCS_DIR := $(PROJECT_ROOT)/docs +JEKYLL_DIR := $(DOCS_DIR)/jekyll +README_GEN_DIR := $(JEKYLL_DIR)/tmp_readme +CHANGELOG_DIR := $(PROJECT_ROOT)/changelogs +CHANGELOG_RELEASE_DIR := $(CHANGELOG_DIR)/releases +# -------------------------------------------------- +# ๐Ÿ“„ Build Files +# -------------------------------------------------- +README_FILE := $(PROJECT_ROOT)/README.md +CHANGELOG_FILE := $(CHANGELOG_DIR)/CHANGELOG.md +CHANGELOG_RELEASE_FILE := $(CHANGELOG_RELEASE_DIR)/$(RELEASE).md +# -------------------------------------------------- +# ๐Ÿช Template Directories (cookiecutter) +# -------------------------------------------------- +COOKIE_DIR := {{ cookiecutter.project_slug }} +COOKIE_MACRO_DIR := $(COOKIE_DIR)/.cookiecutter_includes +RENDERED_COOKIE_DIR := /tmp/rendered +RENDERED_VENV_DIR := $(RENDERED_COOKIE_DIR)/**/.venv +# -------------------------------------------------- +# ๐Ÿ Python / Virtual Environment +# -------------------------------------------------- +PYTHON_CMD := python3.11 +VENV_DIR := $(PROJECT_ROOT)/.venv +# -------------------------------------------------- +# ๐Ÿ Python Dependencies +# -------------------------------------------------- +DEPS := . +DEV_DEPS := .[dev] +DEV_DOCS := .[docs] +# -------------------------------------------------- +# ๐Ÿ Python Commands +# -------------------------------------------------- +CREATE_VENV := $(PYTHON_CMD) -m venv $(VENV_DIR) +ACTIVATE := source $(VENV_DIR)/bin/activate +PYTHON := $(ACTIVATE) && $(PYTHON_CMD) +PIP := $(PYTHON) -m pip +# -------------------------------------------------- +# ๐Ÿช Render template (cookiecutter, cookiecutter_project_upgrader) +# -------------------------------------------------- +COOKIECUTTER := $(ACTIVATE) && cookiecutter +PROJECT_UPGRADE := $(ACTIVATE) && cookiecutter_project_upgrader +# -------------------------------------------------- +# ๐Ÿงฌ Dependency Management (deptry) +# -------------------------------------------------- +DEPTRY := $(ACTIVATE) && deptry +# -------------------------------------------------- +# ๐Ÿ›ก๏ธ Security Audit (pip-audit) +# -------------------------------------------------- +PIPAUDIT := $(ACTIVATE) && pip-audit +# -------------------------------------------------- +# ๐ŸŽจ Formatting (black) +# -------------------------------------------------- +BLACK := $(PYTHON) -m black +# -------------------------------------------------- +# ๐Ÿ” Linting (ruff, yaml, jinja2) +# -------------------------------------------------- +DJLINT := $(ACTIVATE) && djlint +RUFF := $(PYTHON) -m ruff +TOMLLINT := tomllint +YAMLLINT := $(PYTHON) -m yamllint +JINJA := $(ACTIVATE) && jinja2 --strict \ + --extension=cookiecutter.extensions.JsonifyExtension \ + --extension=cookiecutter.extensions.RandomStringExtension \ + --extension=cookiecutter.extensions.SlugifyExtension \ + --extension=cookiecutter.extensions.TimeExtension \ + --extension=cookiecutter.extensions.UUIDExtension +# -------------------------------------------------- +# ๐ŸŽ“ Spellchecker (codespell) +# -------------------------------------------------- +CODESPELL := $(ACTIVATE) && codespell +# -------------------------------------------------- +# ๐Ÿง  Typing (mypy) +# -------------------------------------------------- +MYPY := $(PYTHON) -m mypy +# -------------------------------------------------- +# ๐Ÿงช Testing (pytest) +# -------------------------------------------------- +PYTEST := $(PYTHON) -m pytest +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll + nutrimatic) +# -------------------------------------------------- +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve +# -------------------------------------------------- +# ๐Ÿ”– Version Bumping (bumpy-my-version) +# -------------------------------------------------- +BUMPVERSION := $(ACTIVATE) && bump-my-version bump --verbose +# Patch types: +MAJOR := major +MINOR := minor +PATCH := patch +# -------------------------------------------------- +# ๐Ÿ“œ Changelog generation (git-clif) +# -------------------------------------------------- +GITCLIFF := git cliff +GITCLIFF_CHANGELOG := $(GITCLIFF) --output $(CHANGELOG_FILE) +GITCLIFF_CHANGELOG_RELEASE := $(GITCLIFF) --unreleased --tag $(RELEASE) --output $(CHANGELOG_RELEASE_FILE) +# -------------------------------------------------- +# ๐Ÿ™ Github Tools (git) +# -------------------------------------------------- +GIT := git +GITHUB := gh +# Commands: +GIT_INIT_STATUS := git rev-parse --is-inside-work-tree > /dev/null 2>&1 +# -------------------------------------------------- +# ๐Ÿšจ Pre-Commit (pre-commit) +# -------------------------------------------------- +PRECOMMIT := $(ACTIVATE) && pre-commit +# -------------------------------------------------- +# ๐Ÿƒโ€โ™‚๏ธ Nutri-Matic command +# -------------------------------------------------- +NUTRIMATIC := $(PYTHON) -m nutrimatic +# -------------------------------------------------- +# Functions +# -------------------------------------------------- +# Finds files of a given extension or "*" (all files) under a directory, +# skipping VENV_DIR and template markers like {{ }}. +define get_files_by_extension + find $(1) -name "$(2)" \ + ! -path "$(VENV_DIR)/*" \ + ! -path "$(RENDERED_VENV_DIR)/*" \ + ! -path "*{{*" \ + ! -path "*}}*" \ + ! -name "__init__.j2" \ + -print0 +endef + +JINJA_FILE_LIST := ( \ + $(call get_files_by_extension,$(PROJECT_ROOT),*.j2); \ + $(call get_files_by_extension,$(RENDERED_COOKIE_DIR),*.j2) \ + ) +TOML_FILE_LIST := ( \ + $(call get_files_by_extension,$(PROJECT_ROOT),*.toml); \ + $(call get_files_by_extension,$(RENDERED_COOKIE_DIR),*.toml) \ + ) +# -------------------------------------------------- +.PHONY: \ + all list-folders venv python-install \ + pre-commit-init security dependency-check black-formatter-check \ + black-formatter-fix render-cookiecutter jinja2-lint-check ruff-lint-check \ + ruff-lint-fix toml-lint-check yaml-lint-check format-check \ + format-fix lint-check lint-fix spellcheck \ + typecheck test jekyll readme \ + jekyll-serve run-docs build-docs bump-version-patch \ + changelog git-release pre-commit pre-release \ + release clean-docs clean-build clean \ + version help +# -------------------------------------------------- +# Default: run lint, typecheck, spellcheck, tests, & docs +# -------------------------------------------------- +all: python-install lint-check typecheck spellcheck test build-docs +# -------------------------------------------------- +# Make Internal Utilities +# -------------------------------------------------- +list-folders: + $(AT)printf "\ + ๐Ÿ src: $(SRC_DIR)\n\ + ๐Ÿงช Test: $(TESTS_DIR)\n" +# -------------------------------------------------- +# Dependency Checks +# -------------------------------------------------- +git-dependency-check: + $(AT)which $(GIT) >/dev/null || \ + { echo "Git is required: sudo apt install git"; exit 1; } + +gh-dependency-check: + $(AT)which $(GITHUB) >/dev/null || \ + { echo "GitHub is required: sudo apt install gh"; exit 1; } +# -------------------------------------------------- +# ๐Ÿ Virtual Environment Setup +# -------------------------------------------------- +venv: + $(AT)echo "๐Ÿ Creating virtual environment..." + $(AT)$(CREATE_VENV) + $(AT)echo "โœ… Virtual environment created." + +python-install: venv + $(AT)echo "๐Ÿ“ฆ Installing project dependencies..." + $(AT)$(PIP) install --upgrade pip setuptools wheel + # $(AT)$(PIP) install -e $(DEPS) + $(AT)$(PIP) install -e $(DEV_DEPS) + $(AT)$(PIP) install -e $(DEV_DOCS) + $(AT)echo "โœ… Dependencies installed." +# -------------------------------------------------- +# ๐Ÿšจ Pre-Commit (pre-commit) +# -------------------------------------------------- +# Note: Run as part of project initialization. No manual run needed. +pre-commit-init: + $(AT)echo "๐Ÿ“ฆ Installing pre-commit hooks and hook-types..." + $(AT)which $(GIT) >/dev/null || { echo "Git is required"; exit 1; } + $(AT)$(PRECOMMIT) install --install-hooks + $(AT)$(PRECOMMIT) install --hook-type pre-commit --hook-type commit-msg + $(AT)echo "โœ… pre-commit dependencies installed!" +# -------------------------------------------------- +# ๐Ÿช Project Updater (cookiecutter_project_upgrader) +# -------------------------------------------------- +project-upgrade: + $(AT)echo "๐Ÿช Upgrading project from initial cookiecutter template..." + $(AT)$(PROJECT_UPGRADE) --context-file ./docs/cookiecutter_input.json \ + --upgrade-branch main \ + -e "cookiecutter.json" \ + -e "$(COOKIE_DIR)" + $(AT)echo "โœ… Finished project upgrade!" +# -------------------------------------------------- +# ๐Ÿ›ก๏ธ Security (pip-audit) +# -------------------------------------------------- +security: + $(AT)echo "๐Ÿ›ก๏ธ Running security audit..." + $(AT)$(call run_ci_safe, $(PIPAUDIT)) + $(AT)echo "โœ… Finished security audit!" +# -------------------------------------------------- +# ๐Ÿงฌ Dependency Management (deptry) +# -------------------------------------------------- +dependency-check: + $(AT)echo "๐Ÿงฌ Checking dependency issues..." + $(AT)$(DEPTRY) --pep621-dev-dependency-groups dev,docs \ + $(SRC_DIR) + $(AT)echo "โœ… Finished checking for dependency issues!" +# -------------------------------------------------- +# ๐ŸŽจ Formatting (black) +# -------------------------------------------------- +black-formatter-check: + $(AT)echo "๐Ÿ” Running black formatter style check..." + $(AT)$(call run_ci_safe, $(BLACK) --check $(SRC_DIR) $(TESTS_DIR)) + $(AT)echo "โœ… Finished formatting check of Python code with Black!" + +black-formatter-fix: + $(AT)echo "๐ŸŽจ Running black formatter fixes..." + $(AT)$(BLACK) $(SRC_DIR) $(TESTS_DIR) + $(AT)echo "โœ… Finished formatting Python code with Black!" + +format-check: black-formatter-check +format-fix: black-formatter-fix +# -------------------------------------------------- +# ๐Ÿ” Linting (jinja2, ruff, toml, & yaml) +# -------------------------------------------------- +render-cookiecutter: + $(AT)rm -rf $(RENDERED_COOKIE_DIR) + $(AT)$(COOKIECUTTER) . --no-input \ + --output-dir $(RENDERED_COOKIE_DIR) \ + --overwrite-if-exists \ + --keep-project-on-failure + +djlint-lint-check: + $(AT)echo "๐Ÿ” djlint lint..." + $(AT)$(DJLINT) . --lint --profile=jinja + $(AT)echo "โœ… Finished linting check of jinja2 macro files with djlint!" + +djlint-lint-fix: + $(AT)echo "๐Ÿ” djlint reformat..." + $(AT)$(DJLINT) . --reformat + $(AT)echo "โœ… Finished reformatting of jinja2 macro files with djlint!" + +# Deprecated for cookiecutter projects (USE: djlint-lint-check) +jinja2-lint-check: + $(AT)echo "๐Ÿ” jinja2 lint..." + $(AT)jq '{cookiecutter: .}' cookiecutter.json > /tmp/_cc_wrapped.json + $(AT)$(JINJA_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && $(JINJA_FILE_LIST) | \ + while IFS= read -r -d '' f; do \ + if file "$$f" | grep -q text; then \ + echo "Checking $$f"; \ + $(JINJA) "$$f" /tmp/_cc_wrapped.json || exit 1; \ + fi; \ + done + $(AT)echo "โœ… Finished linting check of jinja2 macro files with jinja2!" + +ruff-lint-check: + $(AT)echo "๐Ÿ” Running ruff linting..." + $(AT)$(MAKE) list-folders + $(AT)$(RUFF) check --config pyproject.toml $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting check of Python code with Ruff!" + +ruff-lint-fix: + $(AT)echo "๐ŸŽจ Running ruff lint fixes..." + $(AT)$(RUFF) check --config pyproject.toml --show-files $(SRC_DIR) $(TESTS_DIR) + $(AT)$(RUFF) check --config pyproject.toml --fix $(SRC_DIR) $(TESTS_DIR) \ + --force-exclude '$(COOKIE_DIR)/pyproject.toml' + $(AT)echo "โœ… Finished linting Python code with Ruff!" + +toml-lint-check: + $(AT)echo "๐Ÿ” Running Tomllint..." + $(AT)$(TOML_FILE_LIST) | tr '\0' '\n' + $(AT)$(ACTIVATE) && \ + $(TOML_FILE_LIST) \ + | xargs -0 -n 1 $(TOMLLINT) + $(AT)echo "โœ… Finished linting check of toml files with Tomllint!" + +yaml-lint-check: + $(AT)echo "๐Ÿ” Running yamllint..." + $(AT)$(YAMLLINT) $(PROJECT_ROOT) + $(AT)$(YAMLLINT) $(RENDERED_COOKIE_DIR) + $(AT)echo "โœ… Finished linting check of yaml files with yamllint!" + +lint-check: render-cookiecutter djlint-lint-check ruff-lint-check toml-lint-check yaml-lint-check +lint-fix: ruff-lint-fix +# -------------------------------------------------- +# ๐ŸŽ“ Spellchecker (codespell) +# -------------------------------------------------- +spellcheck: + $(AT)echo "๐ŸŽ“ Checking Spelling (codespell)..." + $(AT)$(call run_ci_safe, $(CODESPELL)) + $(AT)echo "โœ… Finished spellcheck!" +# -------------------------------------------------- +# ๐Ÿง  Typechecking (MyPy) +# -------------------------------------------------- +typecheck: + $(AT)echo "๐Ÿง  Checking types (MyPy)..." + $(AT)$(MAKE) list-folders + $(AT)$(call run_ci_safe, $(MYPY) $(SRC_DIR) $(TESTS_DIR)) + $(AT)echo "โœ… Python typecheck complete!" +# -------------------------------------------------- +# ๐Ÿงช Testing (pytest) +# -------------------------------------------------- +test: + $(AT)echo "๐Ÿงช Running tests with pytest..." + $(AT)$(call run_ci_safe, $(PYTEST)) + $(AT)echo "โœ… Python tests complete!" +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll + nutrimatic) +# -------------------------------------------------- +ruby-install: + $(MAKE) -C $(JEKYLL_DIR) ruby-install; + +jekyll: + $(MAKE) -C $(JEKYLL_DIR) all; + +jekyll-serve: docs + $(MAKE) -C $(JEKYLL_DIR) run; + +readme: + $(AT)$(NUTRIMATIC) build readme $(JEKYLL_DIR) $(README_FILE) \ + --tmp-dir $(README_GEN_DIR) --jekyll-cmd '$(JEKYLL_BUILD)' + +# Note: Run as part of pre-commit. No manual run needed. +build-docs: jekyll readme + $(AT)$(GIT) add $(DOCS_DIR) + $(AT)$(GIT) add $(README_FILE) + +run-docs: jekyll-serve +# -------------------------------------------------- +# ๐Ÿ”– Version Bumping (bumpy-my-version) +# -------------------------------------------------- +# TODO: Also create a git tag of current version. +bump-version-patch: + $(AT)echo "๐Ÿ”– Updating $(PROJECT_NAME) version from $(VERSION)..." + $(AT)$(BUMPVERSION) $(PATCH) + $(AT)echo "โœ… $(PROJECT_NAME) version update complete!" +# -------------------------------------------------- +# ๐Ÿ“œ Changelog generation (git-cliff) +# -------------------------------------------------- +# Note: Run as part of pre-commit. No manual run needed. +changelog: + $(AT)echo "๐Ÿ“œ $(PROJECT_NAME) Changelog Generation..." + $(AT)$(GITCLIFF_CHANGELOG) + $(AT)$(GITCLIFF_CHANGELOG_RELEASE) + $(AT)$(GIT) add $(CHANGELOG_FILE) + $(AT)$(GIT) add $(CHANGELOG_RELEASE_FILE) + $(AT)echo "โœ… Finished Changelog Update!" +# -------------------------------------------------- +# ๐Ÿ™ Github Commands (git) +# -------------------------------------------------- +# Note: Run as part of project initialization. No manual run needed. +git-init: git-dependency-check + $(AT)if ! $(GIT_INIT_STATUS); then \ + echo "๐ŸŒฑ $(PROJECT_NAME) Git initialization! ๐ŸŽ‰"; \ + $(GIT) init; \ + $(GIT) add --all; \ + $(GIT) commit -m "chore(init): Init commit. \ + Project $(PROJECT_NAME) template generation complete."; \ + echo "โœ… Finished Git initialization!"; \ + else \ + echo "โ„น๏ธ Git is already initialized for $(PROJECT_NAME)."; \ + fi + +git-release: + $(AT)if $(GIT_INIT_STATUS); then \ + echo "๐Ÿ“ฆ $(PROJECT_NAME) Release Tag - $(RELEASE)! ๐ŸŽ‰"; \ + $(GIT) tag -a $(RELEASE) -m "Release $(RELEASE)"; \ + $(GIT) push origin $(RELEASE); \ + $(GITHUB) release create $(RELEASE) --generate-notes; \ + echo "โœ… Finished uploading Release - $(RELEASE)! ๐ŸŽ‰"; \ + else \ + echo "โŒ Git is not yet initialized. Skipping version release." \ + fi +# -------------------------------------------------- +# ๐Ÿ“ข Release +# -------------------------------------------------- +pre-commit: test security dependency-check format-fix lint-check spellcheck typecheck +pre-release: clean python-install pre-commit build-docs changelog build +release: git-release bump-version-patch +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean-docs: + $(AT)echo "๐Ÿงน Cleaning documentation artifacts..." + $(AT)$(MAKE) -C $(JEKYLL_DIR) clean + $(AT)echo "โœ… Cleaned documentation artifacts..." + +clean-build: + $(AT)echo "๐Ÿงน Cleaning build artifacts..." + $(AT)rm -rf build dist *.egg-info + $(AT)find $(SRC_DIR) $(TESTS_DIR) -name "__pycache__" -type d -exec rm -rf {} + + $(AT)-[ -d "$(VENV_DIR)" ] && rm -r $(VENV_DIR) + $(AT)echo "๐Ÿงน Cleaned build artifacts." + +clean: clean-docs clean-build +# -------------------------------------------------- +# Version +# -------------------------------------------------- +version: + $(AT)echo "$(PROJECT_NAME)" + $(AT)echo "author: $(AUTHOR)" + $(AT)echo "version: $(VERSION)" +# -------------------------------------------------- +# โ“ Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PROJECT_NAME) Makefile" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make venv Create python virtual environment (venv)" + $(AT)echo " make install Install python project dependencies (pip)" + $(AT)echo " make security Security audit (pip-audit)" + $(AT)echo " make dependency-check dependency check (deptry)" + $(AT)echo " make black-formatter-check Run Black python formatter check (black)" + $(AT)echo " make black-formatter-fix Run Black python formatter (black)" + $(AT)echo " make format-check Run all project formatter checks (black)" + $(AT)echo " make format-fix Run all project formatter autofixes (black)" + $(AT)echo " make jinja2-lint-check Run jinja linter (jinja-cmd)" + $(AT)echo " make ruff-lint-check Run Ruff linter (ruff)" + $(AT)echo " make ruff-lint-fix Auto-fix python lint issues (ruff)" + $(AT)echo " make toml-lint-check Run TOML linter (tomllint)" + $(AT)echo " make yaml-lint-check Run YAML linter (yamllint)" + $(AT)echo " make lint-check Run all project linters (jinja2, ruff, toml, & yaml)" + $(AT)echo " make lint-fix Run all project linter autofixes (ruff)" + $(AT)echo " make spellcheck Run spellcheck (codespell)" + $(AT)echo " make typecheck Run type checking (mypy)" + $(AT)echo " make test Run test suite (pytest)" + $(AT)echo " make jekyll Generate Jekyll Documentation" + $(AT)echo " make build-docs Build all project documentation" + $(AT)echo " make run-docs Serve Jekyll site locally" + $(AT)echo " make clean Clean build artifacts" + $(AT)echo " make version Displays project information." + $(AT)echo " make all Run lint, typecheck, test, and docs" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/README.md b/README.md deleted file mode 100644 index 8555777..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# supreme_bot_chrome \ No newline at end of file diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..9e2feb0 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,86 @@ +# cliff.toml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# Git-Cliff config for hybrid changelog system +[git] +conventional_commits = true +filter_unconventional = false +include_commits = "all" + +commit_parsers = [ + { message = "^init", group = "๐ŸŒฑ Init", type = "init" }, + { message = "^feat", group = "๐Ÿš€ Added", type = "feat" }, + { message = "^fix", group = "๐Ÿ› Fixed", type = "fix" }, + { message = "^doc", group = "๐Ÿ“š Documentation", type = "docs" }, + { message = "^perf", group = "โšก Performance", type = "perf" }, + { message = "^refactor", group = "๐Ÿšœ Refactoring", type = "refactor" }, + { message = "^style", group = "๐ŸŽจ Styling", type = "style" }, + { message = "^test", group = "๐Ÿงช Tests", type = "test" }, + { message = "^deprecate", group = "โš ๏ธ Deprecated", type = "deprecate" }, + { message = "^remove", group = "๐Ÿšซ Removed", type = "remove" }, + { message = "^security", group = "๐Ÿ”’ Security", type = "security" }, + { message = "^chore|^ci", group = "โš™๏ธ Miscellaneous", type = "chore" }, + { message = ".*", group = "โš™๏ธ Miscellaneous", type = "chore" }, +] + +exclude = [ + "^Merge", + "^chore: bump version", + "^chore: update changelog", + "^docs: update readme", +] + +[sections] +"๐ŸŒฑ Init" = ["init"] +"๐Ÿš€ Added" = ["feat"] +"๐Ÿ› Fixed" = ["fix"] +"๐Ÿ“š Documentation" = ["docs"] +"โšก Performance" = ["perf"] +"๐Ÿšœ Refactoring" = ["refactor"] +"๐ŸŽจ Styling" = ["style"] +"๐Ÿงช Tests" = ["test"] +"โš ๏ธ Deprecated" = ["deprecate"] +"๐Ÿšซ Removed" = ["remove"] +"๐Ÿ”’ Security" = ["security"] +"๐Ÿ‘ท CI" = ["ci"] +"๐Ÿ”จ Build System" = ["build"] +"โš™๏ธ Miscellaneous" = ["chore"] + +[changelog] +# This tells git-cliff to manage the file persistently +header = """ +# -------------------------------------------------- +# Changelog: +# -------------------------------------------------- + +""" +# This setting controls how new entries are added +prepend = true + +# Sorts commits from oldest to newest within each release section +sort = "oldest" +# Hides sections if they have no commits in that release +filter_sections = true +# Use a custom template to define the output format +template = """ +{% for section, commits in sections %} +## {{ section | striptags | trim }} +{% for commit in commits %} +* {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.external_link }})) +{% endfor %} +{% endfor %} +""" diff --git a/cookiecutter.json b/cookiecutter.json new file mode 100644 index 0000000..0e5ecd5 --- /dev/null +++ b/cookiecutter.json @@ -0,0 +1,56 @@ +{ + "project_name": "project-name-cookiecutter", + "project_slug": "{{ cookiecutter.project_name | slugify }}", + "author": "Jared Cook", + "email": "jcook3701+github@gmail.com", + "version": "0.1.0", + "license": [ + "GPL-3.0", + "Apache-2.0", + "BSD-3-Clause", + "MIT" + ], + "__copyright": "Copyright (c) {% now 'utc', '%Y' %} {{ cookiecutter.author }}", + "description": "Description of cookiecutter template project.", + "python_version": [ + "3.11", + "3.10" + ], + "__python": { + "package_name": "{{ cookiecutter.project_slug }}", + "target_version": "py{{ cookiecutter.python_version|replace('.', '') }}", + "keywords": [ + "python3", + "cookiecutter", + "template", + "automation" + ] + }, + "ga_tracking": "G-C7PWLWSHB9", + "github_username": "jcook3701", + "twitter_username": "", + "linkedin_usercode": "jared-cook-b3585a114", + "buymeacoffee_username": "jcook3701", + "theme": [ + "pmarsceill/just-the-docs", + "carlosperate/jekyll-theme-rtd" + ], + "_hooks": { + "post_gen_make_cmds": { + "install": true, + "git-init": true, + "pre-commit-init": true, + "changelog": true, + "build-docs": false + } + }, + "_copy_without_render": [ + ".github/workflows/*" + ], + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "add_github_docs": true, + "add_sphinx_docs": false +} diff --git a/cspell.json b/cspell.json new file mode 100644 index 0000000..10dd128 --- /dev/null +++ b/cspell.json @@ -0,0 +1,59 @@ +{ + "version": "0.2", + "language": "en", + "useGitignore": true, + "words": [ + "bumpversion", + "cla", + "ccla", + "cli", + "codespell", + "cookiecutter", + "cookiecutter_project_upgrader", + "dco", + "deptry", + "ehthumbs", + "gitcliff", + "githubusercontent", + "icla", + "mkdirp", + "nutrimatic", + "nutri-matic", + "pipaudit", + "pip-audit", + "pyproject", + "pytest", + "rpmnew", + "rustc", + "streetsidesoftware", + "tomllint", + "tsmerge", + "upgrader", + "venv", + "visualstudio", + "vsmarketplacebadge", + "yaml" + ], + "flagWords": [ + "hte" + ], + "dictionaries": [ + "bash", + "companies", + "css", + "public-licenses", + "docker", + "django", + "filetypes", + "git", + "html", + "javascript", + "misc", + "npm", + "python", + "python-common", + "rust", + "softwareTerms", + "typescript" + ] +} diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json new file mode 100644 index 0000000..cd80eb6 --- /dev/null +++ b/docs/cookiecutter_input.json @@ -0,0 +1,65 @@ +{ + "__python": { + "keywords": [ + "docs", + "github-docs", + "github-pages", + "python3", + "cookiecutter", + "template", + "automation" + ], + "project_name": "github-docs-cookiecutter", + "target_version": "py311" + }, + "__year_range": "2025-2026", + "_checkout": "main", + "_copy_without_render": [], + "_default_branch": "main", + "_extensions": [ + "jinja2.ext.do", + "jinja2.ext.loopcontrols" + ], + "_hooks": { + "post_gen_make_cmds": { + "build-docs": false, + "changelog": false, + "git-init": false, + "pre-commit-init": false, + "python-install": false + } + }, + "_is_sub_template": false, + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "_output_dir": "/home/jcook/Documents/git_repo/github-doc-cookiecutter/.git/cookiecutter", + "_repo_dir": "/home/jcook/.cookiecutters/cookiecutter-cookiecutter", + "_template": "git@github.com:jcook3701/cookiecutter-cookiecutter.git", + "add_github_docs": true, + "add_sphinx_docs": false, + "author": "Jared Cook", + "buymeacoffee_username": "jcook3701", + "company": null, + "contribution_model": "CLA", + "copyright": "Copyright (c) 2025-2026, Jared Cook", + "current_year": "2026", + "description": "Github docs cookiecutter template generation.", + "email": "jcook3701+github@gmail.com", + "ga_tracking": "G-C7PWLWSHB9", + "github_org": null, + "github_username": "jcook3701", + "license": "AGPL-3.0-or-later", + "linkedin_usercode": "jared-cook-b3585a114", + "project_name": "github-docs-cookiecutter", + "project_slug": "github-docs-cookiecutter", + "publication_year": "2025", + "python_version": "3.11", + "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", + "template_type": "cookiecutter", + "theme": "pmarsceill/just-the-docs", + "timezone": "America/Los_Angeles", + "twitter_username": "", + "version": "0.1.1" +} diff --git a/docs/jekyll/.gitignore b/docs/jekyll/.gitignore new file mode 100644 index 0000000..1c2a791 --- /dev/null +++ b/docs/jekyll/.gitignore @@ -0,0 +1,74 @@ +# .gitignore +# ========================================= +# Project: github-docs-cookiecutter +# ========================================= + +# ========================================= +## Jekyll Ignores +# ========================================= +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# ========================================= +# Ignore folders generated by Bundler +# ========================================= +.bundle/ +vendor/ + +# ========================================= +## Default Ignores +# ========================================= + +# ========================================= +# Backup Extensions # +# ========================================= +*.bak +*.old +*.save +# ========================================= +# Emacs Tmp Extensions # +# ========================================= +*.tmp +*.tmp.* +.#* +# ========================================= +# Compiled source Extensions # +# ========================================= +*.com +*.class +*.dll +*.exe +*.o +*.so +# ========================================= +# Package Extensions # +# ========================================= +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip +# ========================================= +# Logs and databases Extensions # +# ========================================= +*.log +*.sql +*.sqlite +# ========================================= +# OS generated files # +# ========================================= +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json @@ -0,0 +1 @@ +{} diff --git a/docs/jekyll/Gemfile b/docs/jekyll/Gemfile new file mode 100755 index 0000000..d242ae4 --- /dev/null +++ b/docs/jekyll/Gemfile @@ -0,0 +1,16 @@ +source 'https://rubygems.org' + +# Core Dependencies +gem "faraday", "~> 2.14" +gem "faraday-retry", "~> 2.3" +gem "jekyll", "~> 4.4" +gem "just-the-docs", "~> 0.11" + +group :jekyll_plugins do + gem "jekyll-seo-tag" + gem "jekyll-sitemap" + gem "jekyll-include-cache" + gem "jekyll-github-metadata" + gem "jekyll-remote-theme" + gem "jekyll-redirect-from" +end diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile new file mode 100644 index 0000000..d0f6035 --- /dev/null +++ b/docs/jekyll/Makefile @@ -0,0 +1,96 @@ +# Makefile +# ========================================= +# Project: github-docs for github-docs-cookiecutter +# ========================================= + +# -------------------------------------------------- +# โš™๏ธ Environment Settings +# -------------------------------------------------- +SHELL := /bin/bash +.SHELLFLAGS := -O globstar -c +# If V is set to '1' or 'y' on the command line, +# AT will be empty (verbose). Otherwise, AT will +# contain '@' (quiet by default). The '?' is a +# conditional assignment operator: it only sets V +# if it hasn't been set externally. +V ?= 0 +ifeq ($(V),0) + AT = @ +else + AT = +endif +# Detect if we are running inside GitHub Actions CI. +# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. +# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. +ifeq ($(GITHUB_ACTIONS),true) +CI := 1 +else +CI := 0 +endif +# Define a reusable CI-safe runner +define run_ci_safe = +( $1 || [ "$(CI)" != "1" ] ) +endef +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PACKAGE_NAME = "github-docs-cookiecutter" +AUTHOR = "Jared Cook" +VERSION = "0.1.1" +PUBLISHDIR ?= +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Sphinx + Jekyll) +# -------------------------------------------------- +RUBY_INSTALL := bundle install +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve +# -------------------------------------------------- +.PHONY: all ruby-install jekyll jekyll-serve build run clean help +# -------------------------------------------------- +# Default: +# -------------------------------------------------- +all: ruby-install build +# -------------------------------------------------- +# โ™ฆ๏ธ Ruby +# -------------------------------------------------- +ruby-install: + $(AT)$(RUBY_INSTALL) +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll) +# -------------------------------------------------- +jekyll: + $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“š..." + $(AT)$(JEKYLL_BUILD) + $(AT)echo "โœ… Full documentation build complete!" + +jekyll-serve: + $(AT)echo "๐Ÿš€ Starting Jekyll development server..." + $(AT)$(JEKYLL_SERVE) + +build: jekyll +run: jekyll-serve +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean: + $(AT)echo "๐Ÿงน Cleaning Jekyll build artifacts..." + $(AT)$(call run_ci_safe,$(JEKYLL_CLEAN)) + $(AT)echo "โœ… Cleaned Jekyll build artifacts." +# -------------------------------------------------- +# Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PACKAGE_NAME) github documentation Makefile" + $(AT)echo " author: $(PACKAGE_AUTHOR)" + $(AT)echo " version: $(PACKAGE_VERSION)" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make ruby-install Installs Gemfile packages." + $(AT)echo " make build Generate Jekyll documentation" + $(AT)echo " make run Serve Jekyll site locally" + $(AT)echo " make clean Clean Jekyll build artifacts" + $(AT)echo " make all Run make (build)" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md new file mode 100644 index 0000000..0fc5cca --- /dev/null +++ b/docs/jekyll/README.md @@ -0,0 +1,34 @@ +# {{ site.title }} + +[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE) + +__Author:__ {{ site.author }} +__Version:__ {{ site.version }} + +## Overview +{{ site.description }} + +__CI/CD Check List:__ +* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg) +* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg) +* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg) +* ![security-audit]({{ site.repo_url }}/actions/workflows/security-audit.yml/badge.svg) +* ![spellcheck]({{ site.repo_url }}/actions/workflows/spellcheck.yml/badge.svg) +* ![tests]({{ site.repo_url }}/actions/workflows/tests.yml/badge.svg) +* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) + +*** + +## Usage Examples + +## Advance Examples + +## Development Strategy + +## License +{{ cookiecutter.copyright }} + +This project is licensed under the __{{ cookiecutter.license }} License__. +See the [LICENSE](LICENSE) file for the full license text. + +SPDX-License-Identifier: {{ cookiecutter.license }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml new file mode 100755 index 0000000..f8410b2 --- /dev/null +++ b/docs/jekyll/_config.yml @@ -0,0 +1,164 @@ +# github-docs-cookiecutter Documentation +--- +title: "github-docs-cookiecutter" +author: "Jared Cook" +version: "0.1.1" +timezone: "America/Los_Angeles" +description: "Github docs cookiecutter template generation." +remote_theme: "pmarsceill/just-the-docs" +ga_tracking: "G-C7PWLWSHB9" + +repo_url: "https://github.com/jcook3701/github-docs-cookiecutter" +repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/None/" + +repository: "jcook3701/github-docs-cookiecutter" + +# Specifies the site's subpath for correct URL generation +baseurl: "/github-docs-cookiecutter" + +collections: + manual: + output: true + permalink: /:collection/:path + + resources: + output: true + permalink: /:collection/:path + +just_the_docs: + collections: + manual: + name: Manual + nav_fold: true + nav_exclude: false + + resources: + name: "External Links" + nav_fold: false + nav_exclude: false + +plugins: + - jekyll-remote-theme + - jekyll-redirect-from + - jekyll-seo-tag + - jekyll-github-metadata + - jekyll-include-cache + - jekyll-sitemap + +# Author Remote User Accounts +# twitter_username: "" +github_username: "jcook3701" +linkedin_usercode: "jared-cook-b3585a114" +buymeacoffee_username: "jcook3701" + +# carousel_images: +# - /assets/images/ +# - /assets/images/ +# - /assets/images/ + +# Set a path/url to a logo that will be displayed instead of the title +# logo: /assets/images/icon128.png + +# Enable or disable the site search +search_enabled: true + +# For copy button on code +enable_copy_code_button: true + +# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in +mermaid: + # Version of mermaid library + # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ + version: "9.1.6" + # Note: Put any additional configuration, such as setting the theme, + # in _includes/mermaid_config.js. See also docs/ui-components/code. + # Note: To load mermaid from a local library, also use the `path` key + # to specify the location of the library; e.g. for (v10+): + # path: "/assets/js/mermaid.esm.min.mjs" for (- + Copyright (c) 2025-2026, Jared Cook. Distributed by an + + AGPL-3.0-or-later license. + + + +## Footer last edited timestamp +# show or hide edit time - page must have `last_modified_date` defined in the frontmatter +last_edit_timestamp: true +# uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html +last_edit_time_format: >- + %b %e %Y at %I:%M %p +## Footer "Edit this page on GitHub" link text +# show or hide edit this page link +gh_edit_link: true +gh_edit_link_text: "Edit this page on GitHub" +# the github URL for your repo +gh_edit_repository: >- + https://github.com/jcook3701/github-docs-cookiecutter +# the branch that your docs is served from +gh_edit_branch: "master" +# the source that your files originate from +gh_edit_source: docs +# "tree" or "edit" if you want the user to jump into the editor immediately +gh_edit_view_mode: "tree" + +# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define +callouts_level: quiet # or loud +callouts: + highlight: + color: yellow + important: + title: Important + color: blue + new: + title: New + color: green + note: + title: Note + color: purple + warning: + title: Warning + color: red + +kramdown: + auto_ids: true + +include: + - .well-known + +# Exclude files/folders from Jekyll processing +exclude: + - node_modules + - .DS_Store + - Gemfile + - Gemfile.lock + +# Optional SEO metadata +seo: + title: "github-docs-cookiecutter Documentation" + description: "Full code documentation for the github-docs-cookiecutter project" diff --git a/docs/jekyll/_includes/image-carousel.html b/docs/jekyll/_includes/image-carousel.html new file mode 100644 index 0000000..f74f777 --- /dev/null +++ b/docs/jekyll/_includes/image-carousel.html @@ -0,0 +1,64 @@ +
+ +
+ {% assign slides = site.carousel_images %} {% for image in slides %} {% if + image.src %} + {{ image.caption }} + {% else %} + + {% endif %} {% endfor %} +
+ +
+ + + + diff --git a/docs/jekyll/_includes/snippet_loader.html b/docs/jekyll/_includes/snippet_loader.html new file mode 100644 index 0000000..6765a0a --- /dev/null +++ b/docs/jekyll/_includes/snippet_loader.html @@ -0,0 +1,4 @@ + diff --git a/docs/jekyll/_includes/social-bar.html b/docs/jekyll/_includes/social-bar.html new file mode 100644 index 0000000..9dd1a65 --- /dev/null +++ b/docs/jekyll/_includes/social-bar.html @@ -0,0 +1,167 @@ + +
+
    + {% if site.twitter_username %} +
  • + +
    • + {% endif %} + + {% if site.linkedin_usercode %} +
  • + + + +
    • + {% endif %} + + {% if site.github_username %} +
  • + + + +
    • + {% endif %} + + + {% if site.buymeacoffee_username %} +
  • + + + +
    • + {% endif %} +
+
+ + diff --git a/docs/jekyll/_manual/contribute/create-feature-request.md b/docs/jekyll/_manual/contribute/create-feature-request.md new file mode 100644 index 0000000..8c4291b --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-feature-request.md @@ -0,0 +1,59 @@ +--- +layout: default +title: Create a feature request +nav_order: 1 +parent: Contribute +--- +## Create a feature request + +Feature requests help us understand what you need from github-docs-cookiecutter. This document guides you through writing effective feature requests that help maintainers understand your needs and prioritize improvements. + +## Before you begin + +We're excited to hear your ideas! Before you submit a feature request, consider these resources: + +- Read the [Code of Conduct](../CODE_OF_CONDUCT.md) to understand our community guidelines. +- Search [existing feature requests](https://github.com/jcook3701/github-docs-cookiecutter/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Ffeature-request) to see if someone already suggested something similar. + +## Your first feature request + +When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why. + + + +## Best practices for feature requests + +Follow these guidelines to increase the chances of your feature request being accepted: + +### Keep it focused + +Request one feature at a time. If you have multiple ideas, create separate feature requests for each one. This makes it easier to discuss, prioritize, and implement each feature independently. + +### Research first + +Before submitting, search for similar requests. If you find an existing request that's close to your idea, add your use case and context to that discussion instead of creating a duplicate. + +### Provide context + +The more context you provide, the better maintainers can understand your needs. Include: + +- Your environment or setup (which data sources, plugins, or features you're using) +- Your workflow or process +- Why this matters to you +- Any workarounds you've tried + +### Be open to alternatives + +Maintainers might suggest different approaches to solve your problem. Be open to these alternatives as they might be easier to implement or more maintainable in the long term. + +### Stay engaged + +After submitting your feature request, monitor the discussion. Answer questions from maintainers and provide clarification when needed. This helps move your request forward. + +## Contributing the feature yourself + +If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link _manual/contribute/create-pull-request.md %}). + +We welcome community contributions and appreciate your help making github-docs-cookiecutter better! diff --git a/docs/jekyll/_manual/contribute/create-pull-request.md b/docs/jekyll/_manual/contribute/create-pull-request.md new file mode 100644 index 0000000..11a9b6c --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-pull-request.md @@ -0,0 +1,18 @@ +--- +layout: default +title: Create a pull request +nav_order: 1 +parent: Contribute +--- + +## Create a pull request + +Every contribution to github-docs-cookiecutter's software begins with a [pull request](https://help.github.com/en/articles/about-pull-requests/). This document guides you through the process of creating a PR. + +## Before you begin + +We know you're excited to create your first pull request. Before we get started, read these resources first: + +- Get started [contributing to github-docs-cookiecutter]({{ site.repo_url }}/CONTRIBUTING.md). +- Make sure your code follows the relevant [style guides]({% link _manual/contribute/style-guides/index.md %}). +- It's recommended you [set up precommit hooks]({% link _manual/contribute/developer-guide.md %}) to auto-format when you commit. diff --git a/docs/jekyll/_manual/contribute/developer-guide.md b/docs/jekyll/_manual/contribute/developer-guide.md new file mode 100644 index 0000000..cc2a82f --- /dev/null +++ b/docs/jekyll/_manual/contribute/developer-guide.md @@ -0,0 +1,82 @@ +--- +layout: default +title: Developer Guide +nav_order: 1 +parent: Contribute +--- + +## Developer guide + +This guide helps you get started developing github-docs-cookiecutter. + +## Development Strategy + +All Makefile commands are used in __ci/cd__ to ensure that if they pass locally they should also pass once pushed to github. + +### ๐Ÿ๏ธ Build environment (.venv) + +``` shell +$ make install +``` + +### ๐Ÿงฌ Dependency Management (deptry) + +```shell +$ make dependency-check +``` + +### ๐Ÿ›ก๏ธ Security Audit (pip-audit) + +```shell +$ make security +``` + +### ๐ŸŽจ Formatting (black) + +```shell +$ make format-check +``` + +```shell +$ make format-fix +``` + +### ๐Ÿ” Linting (jinja2-cli, ruff, tomllint, & yaml-lint) + +``` shell +$ make lint-check +``` + +``` shell +$ make lint-fix +``` + +### ๐ŸŽ“ Spellchecking (codespell) + +```shell +$ make spellcheck +``` + +### ๐Ÿง  Typechecking (mypy) + +``` shell +$ make typecheck +``` + +### ๐Ÿงช Testing (pytest) + +``` shell +$ make test +``` + +### ๐Ÿš€ Release (git tag) + +```shell +$ make release +``` + +### โ“ Build Help + +``` shell +$ make help +``` diff --git a/docs/jekyll/_manual/contribute/git-commit-message.md b/docs/jekyll/_manual/contribute/git-commit-message.md new file mode 100644 index 0000000..07ad904 --- /dev/null +++ b/docs/jekyll/_manual/contribute/git-commit-message.md @@ -0,0 +1,25 @@ +--- +layout: default +title: "Git Commit Message" +nav_order: 1 +parent: Contribute +--- +## Git Commit Message Format Guide + +Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by pre-commit. + +__example:__ + +```shell +[optional scope]: + +[optional body] + +[optional footer(s)] +``` + +* ``````: A required noun that describes the nature of the change. +* ```[optional scope]```: An optional phrase within parentheses that specifies the part of the codebase being affected (e.g., fix(parser):). +* ``````: A required short, imperative-mood summary of the changes. +* ```[optional body]```: A longer description providing additional context and "what and why" details. +* ```[optional footer(s)]```: Used for adding meta-information, such as issue references (Fixes #123) or indicating breaking changes. diff --git a/docs/jekyll/_manual/contribute/index.md b/docs/jekyll/_manual/contribute/index.md new file mode 100644 index 0000000..55d96c3 --- /dev/null +++ b/docs/jekyll/_manual/contribute/index.md @@ -0,0 +1,17 @@ +--- +layout: default +title: Contribute +nav_order: 1 +has_children: true +--- +## Contribute to the github-docs-cookiecutter project + +We're excited that you're considering making a contribution to the github-docs-cookiecutter project! This is the place to find guides for contributors to our open-source project. + +These are some good resources to explore for developers: + +[Create a pull request]({% link _manual/contribute/create-pull-request.md %}) +[Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +[Developer guide]({% link _manual/contribute/developer-guide.md %}) +[Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) +Find style guides for the github-docs-cookiecutter software project: diff --git a/docs/jekyll/_manual/contribute/merge-pull-request.md b/docs/jekyll/_manual/contribute/merge-pull-request.md new file mode 100644 index 0000000..af1e1de --- /dev/null +++ b/docs/jekyll/_manual/contribute/merge-pull-request.md @@ -0,0 +1,61 @@ +--- +layout: default +title: Merge a pull request +nav_order: 1 +parent: Contribute +--- +## Merge a pull request + +When a pull request has been reviewed and approved by at least one person and all checks have passed, then it's time to merge the pull request. + +## Who is expected to merge a pull request? + +Maintainers are responsible for merging all pull requests. If a maintainer has opened a pull request, then the general rule is that the same maintainer merges the pull request. If a non-maintainer has opened a pull request, then it's suggested that one of the maintainers who reviews the pull request should merge the pull request. + +## Checklist of considerations + +Consider (and ask about) the items on the following checklist before merging a pull request: + +- Is it reviewed and approved? +- Have all checks passed? +- Does it have a proper pull request title? +- Does it need to be added to the changelog (release notes)? +- Does it need backporting? + +## Before merge + +Before actually merging a pull request, consider the following things: + +### Status checks + +Before you can merge a pull request, it must have a review approval, and all the required status checks must pass. + +### Format the pull request title + + + +### Changelog (automated) + +## Doing the actual merge + +The best time to actually merge the pull request varies from case to case. All commits in a pull request are squashed. + +You can change the commit message before merging. Please remember that developers might use the commit information for tasks like reviewing changes of files, doing Git blame, and resolving merge conflicts. + +While there aren't formal best practices around this process, you can consider the following guidance: + +**Do:** + +- Make sure the pull request title is formatted properly before merging. Doing so automatically gives you a good and short summary of the commit. +- Leave `Co-authored-by:` lines as is so that co-authors are credited for the contribution. +- Remove any commit information that doesn't bring any context to the change. + +**Consider:** + +- Keep any references to issues that the pull request fixes, closes, or references. Doing this allows cross-reference between the commit and referenced issue or issues. + +To finalize the merge, click the **Confirm squash and merge** button. + +## After the merge + +Make sure to close any referenced or related issues. We recommend that you assign the same milestone on the issues that the pull request fixes or closes, but this isn't required. diff --git a/docs/jekyll/_manual/contribute/style-guides/index.md b/docs/jekyll/_manual/contribute/style-guides/index.md new file mode 100644 index 0000000..f457906 --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: "Style Guide" +nav_order: 1 +has_children: true +parent: Contribute +--- + +## Style Guides +* [Python](python.md) style guide. +* [Typescript](typescript.md) style guide. diff --git a/docs/jekyll/_manual/contribute/style-guides/python.md b/docs/jekyll/_manual/contribute/style-guides/python.md new file mode 100644 index 0000000..0201964 --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/python.md @@ -0,0 +1,6 @@ +--- +layout: default +title: "Python Style Guide" +nav_order: 1 +parent: "Style Guide" +--- diff --git a/docs/jekyll/_manual/contribute/style-guides/typescript.md b/docs/jekyll/_manual/contribute/style-guides/typescript.md new file mode 100644 index 0000000..9dea0e0 --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/typescript.md @@ -0,0 +1,6 @@ +--- +layout: default +title: "Typescript Style Guide" +nav_order: 1 +parent: "Style Guide" +--- diff --git a/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md new file mode 100644 index 0000000..a98d984 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md @@ -0,0 +1,20 @@ +--- +layout: default +title: CLA Privacy Policy +nav_order: 1 +parent: "Developer Resources" +--- +## github-docs-cookiecutter CLA Privacy Policy + +## Collection and storage of personal data and the nature and purpose of their use + +Most Project business is conducted publicly, and privacy of submitted information is not expected. + +Specifically, information is exchanged via public email lists and public code repositories. Public code repositories use patch submission, pull requests, discussions, and bug reports. None of these tools keep submitted information private. They are publicly accessible and archived in multiple locations around the world, by the Project and third parties. + +You should never submit personally identifiable information (PII) via any of these mechanisms. + + diff --git a/docs/jekyll/_manual/developer-resources/cla.md b/docs/jekyll/_manual/developer-resources/cla.md new file mode 100644 index 0000000..838240d --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla.md @@ -0,0 +1,26 @@ +--- +layout: default +title: Contributor License Agreement (CLA) +nav_order: 1 +parent: "Developer Resources" +--- +## github-docs-cookiecutter Contributor License Agreement ("Agreement") V1.0 + +This agreement is based on the Apache Software Foundation Individual Contributor License Agreement ("Agreement") V2.2 + +Thank you for your interest in __The github-docs-cookiecutter project by Jared Cook,__ dba Jared Cook (the "Project"). To clarify the intellectual property license granted with Contributions from any person or entity, the Project must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of the Project and its users. It does not change your rights to use your own Contributions for any other purpose. + +You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to the Project. In return, the Project shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its nonprofit status and bylaws in effect at the time of the Contribution. Except for the license granted herein to the Project and recipients of software distributed by the Project, You reserve all right, title, and interest in and to Your Contributions. + +1. __Definitions. "You"__ (or __"Your"__) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Project. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Project for inclusion in, or documentation of, any of the products owned or managed by the Project (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Project or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." +2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. +4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Project, or that your employer has executed a separate Corporate CLA with the Project. +5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. +6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. +7. Should You wish to submit work that is not Your original creation, You may submit it to the Project separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". +8. You agree to notify the Project of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. + +This is a legal contract containing Personally Identifiable Information. +Please refer to our [cla-privacy-policy](cla-privacy-policy.md) for the policy +governing how this information is used and shared. diff --git a/docs/jekyll/_manual/developer-resources/contribute.md b/docs/jekyll/_manual/developer-resources/contribute.md new file mode 100644 index 0000000..0d01a0c --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/contribute.md @@ -0,0 +1,31 @@ +--- +layout: default +title: Contribute +nav_order: 2 +parent: "Developer Resources" +--- +## Contribute to github-docs-cookiecutter + +This page lists resources for developers who want to contribute to the github-docs-cookiecutter ecosystem. + +## Make technical contributions + +### Contribute code to github-docs-cookiecutter + +* [Contributing to github-docs-cookiecutter]() +* [Developer guide]() +* [Create a pull request] walks you through preparing a clear, descriptive pull request. +* Browse all [issues](https://github.com/jcook3701/github-docs-cookiecutter/issues/new) to find a good first task. You can also filter by [help wanted](). + +### Contribute without code + +* Report a bug with the [bug report template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=01-bug-report.yml) and include steps to reproduce. +* Submit a [feature request](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature-request.yml) to propose improvements. +* Report security vulnerabilities following our [security policy](). + +### Best practices and style + +Our [style guides]() outline github-docs-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! + * [Python style guide](). + * [Typescript style guide](). + * [YAML style guide](). diff --git a/docs/jekyll/_manual/developer-resources/index.md b/docs/jekyll/_manual/developer-resources/index.md new file mode 100644 index 0000000..2f065ab --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Developer Resources" +nav_order: 1 +has_children: true +--- +## Developer resources + +This section of the documentation contains additional resources for developers and contributors. + +## Contribute to github-docs-cookiecutter + +Refer to the [Contribute to github-docs-cookiecutter]() guide to learn the various ways you can contribute to github-docs-cookiecutter. Read the [github-docs-cookiecutter Contributor License Agreement]() before making any contribution. diff --git a/docs/jekyll/_manual/introduction/index.md b/docs/jekyll/_manual/introduction/index.md new file mode 100644 index 0000000..27d594b --- /dev/null +++ b/docs/jekyll/_manual/introduction/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Introduction +nav_order: 1 +has_children: true +--- +## Introduction to github-docs-cookiecutter diff --git a/docs/jekyll/_manual/setup-guide/index.md b/docs/jekyll/_manual/setup-guide/index.md new file mode 100644 index 0000000..c4f2d7c --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Setup Guide" +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Setup diff --git a/docs/jekyll/_manual/setup-guide/requirements.md b/docs/jekyll/_manual/setup-guide/requirements.md new file mode 100644 index 0000000..7bf7a1d --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/requirements.md @@ -0,0 +1,24 @@ +--- +layout: default +title: Requirements +nav_order: 1 +parent: "Setup Guide" +--- + +## github-docs-cookiecutter Requirements + +1. Python 3.11 + ```shell + $ sudo apt install python3.11 + ``` +2. [rustup](https://rust-lang.org/tools/install/) + __Note:__ I found that it is easiest to use rustup to manage rustc and cargo but this is not required. + __Example:__ Install rustup with the following: + ```shell + $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` +3. [git-cliff](https://git-cliff.org/) + __Note:__ git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. + ```shell + $ cargo install git-cliff + ``` diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md new file mode 100644 index 0000000..df710b0 --- /dev/null +++ b/docs/jekyll/_manual/troubleshooting/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Troubleshooting +nav_order: 1 +has_children: true +--- +## Troubleshooting github-docs-cookiecutter diff --git a/docs/jekyll/_manual/tutorials/index.md b/docs/jekyll/_manual/tutorials/index.md new file mode 100644 index 0000000..937baa9 --- /dev/null +++ b/docs/jekyll/_manual/tutorials/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Tutorials +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Tutorials diff --git a/docs/jekyll/_manual/upgrade-guide/index.md b/docs/jekyll/_manual/upgrade-guide/index.md new file mode 100644 index 0000000..afbc7a7 --- /dev/null +++ b/docs/jekyll/_manual/upgrade-guide/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Upgrade Guide" +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Upgrade Guide + +### ๐Ÿช Project Updater (cookiecutter_project_upgrader) + +```shell +$ source .venv/bin/activate && cookiecutter_project_upgrader --context-file ./docs/cookiecutter_input.json --upgrade-branch main +``` diff --git a/docs/jekyll/_manual/whatsnew/index.md b/docs/jekyll/_manual/whatsnew/index.md new file mode 100644 index 0000000..9ea9be5 --- /dev/null +++ b/docs/jekyll/_manual/whatsnew/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "What's New" +nav_order: 1 +has_children: true +--- +## What's new in github-docs-cookiecutter diff --git a/docs/jekyll/_resources/repository-link.md b/docs/jekyll/_resources/repository-link.md new file mode 100644 index 0000000..98d326c --- /dev/null +++ b/docs/jekyll/_resources/repository-link.md @@ -0,0 +1,5 @@ +--- +title: "github-docs-cookiecutter on GitHub ๐Ÿ”—" +nav_order: 1 +redirect_to: "https://github.com/jcook3701/github-docs-cookiecutter" +--- diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json new file mode 100644 index 0000000..8f6e385 --- /dev/null +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -0,0 +1,43 @@ +{ + "__year_range": "2025-2026", + "_checkout": null, + "_copy_without_render": [ + "README.md", + "_includes/*" + ], + "_extensions": [ + "jinja2.ext.do", + "jinja2.ext.loopcontrols", + "jinja2_time.TimeExtension" + ], + "_is_sub_template": true, + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "_output_dir": "/home/jcook/Documents/git_repo/github-doc-cookiecutter/.git/cookiecutter/github-docs-cookiecutter/docs/_tmp_docs", + "_repo_dir": "/home/jcook/.cookiecutters/github-docs-cookiecutter", + "_template": "https://github.com/jcook3701/github-docs-cookiecutter.git", + "author": "Jared Cook", + "buymeacoffee_username": "jcook3701", + "company": null, + "contribution_model": "CLA", + "copyright": "Copyright (c) 2025-2026, Jared Cook", + "current_year": "2026", + "description": "Github docs cookiecutter template generation.", + "email": "jcook3701+github@gmail.com", + "ga_tracking": "G-C7PWLWSHB9", + "github_org": null, + "github_username": "jcook3701", + "license": "AGPL-3.0-or-later", + "linkedin_usercode": "jared-cook-b3585a114", + "project_name": "github-docs-cookiecutter", + "project_slug": "github-docs-cookiecutter", + "publication_year": "2025", + "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", + "template_type": "cookiecutter", + "theme": "pmarsceill/just-the-docs", + "timezone": "America/Los_Angeles", + "twitter_username": "", + "version": "0.1.1" +} diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md new file mode 100644 index 0000000..d675500 --- /dev/null +++ b/docs/jekyll/index.md @@ -0,0 +1,24 @@ +--- +layout: default +title: github-docs-cookiecutter +nav_order: 1 +description: Github docs cookiecutter template generation. +--- + + + +{% include snippet_loader.html %} + +{% if site.carousel_images %} + {% include image-carousel.html %} +{% endif %} + +{% include_relative README.md %} + +## โ˜• Support Me +If you enjoy this project, please consider buying me a coffee or making a code contribution. + +## Social Links + +{% include social-bar.html %} + diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py new file mode 100644 index 0000000..1518627 --- /dev/null +++ b/hooks/post_gen_project.py @@ -0,0 +1,51 @@ +# post_gen_project.py for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +import json +import os + +from nutrimatic.core import make +from nutrimatic.hooks.post_gen_logic import ( + generate_cliff_changelog_dirs, + generate_docs_templates, + get_make_cmds, +) + + +def main() -> None: + """Cookiecutter Post Generation Scripts""" + # Detect CI (e.g. GitHub Actions, GitLab CI, etc.) + if os.getenv("CI"): + print("โš™๏ธ Detected CI environment โ€” skipping GitHub Docs generation.") + return + os.environ["COOKIECUTTER_HOOKS"] = "true" + + # Access cookiecutter context safely + context = json.loads("""{{ cookiecutter | jsonify }}""") + generate_docs_templates(context) + generate_cliff_changelog_dirs() + + # Run make commands to get project seeded + make_cmds: list[str] = get_make_cmds(context) + + for cmd in make_cmds: + make(cmd) + + +if __name__ == "__main__": + main() diff --git a/hooks/pre_gen_project.py b/hooks/pre_gen_project.py new file mode 100644 index 0000000..2bc4ee0 --- /dev/null +++ b/hooks/pre_gen_project.py @@ -0,0 +1,35 @@ +# pre_gen_project.py for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +import json +import os + + +def main() -> None: + """Cookiecutter Pre Generation Scripts""" + # Detect CI (e.g. GitHub Actions, GitLab CI, etc.) + if os.getenv("CI"): + print("โš™๏ธ Detected CI environment โ€” skipping GitHub Docs generation.") + return + context = json.loads("""{{ cookiecutter | jsonify }}""") + print(f"Context: {context}") + + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..75ff2f0 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,268 @@ +# pyproject.toml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +[build-system] +requires = ["setuptools>=80.0.0", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "github-docs-cookiecutter" +version = "0.1.1" +description = "Github docs cookiecutter template generation." +authors = [ + { name="Jared Cook", email="jcook3701+github@gmail.com" } +] +readme = "README.md" +license = "AGPL-3.0-or-later" +license-files = ["LICENSE"] +requires-python = ">=3.11" +dependencies = [ + "nutri-matic>=0.1", +] +keywords = ["docs", "github-docs", "github-pages", "python3", "cookiecutter", "template", "automation"] +classifiers = [ + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", +] + +[project.urls] +Homepage = "https://github.com/jcook3701/github-docs-cookiecutter" +Repository = "https://github.com/jcook3701/github-docs-cookiecutter" +Documentation = "https://github.com/jcook3701/github-docs-cookiecutter/docs/jekyll" + +[project.optional-dependencies] +dev = [ + "bump-my-version>=1.2", + "black>=25.11", + "codespell>=2.4", + "cookiecutter>=2.6", + "cookiecutter-project-upgrader>=1.3", + "coverage>=7.12", + "deptry>=0.24", + "djlint>=1.36", + "json-lint-tools>=0.1", + "jinja2-cli>=0.8", + "jinja2-time>=0.2", + "mypy==1.9", + "nameisok>=0.1", + "pip-audit>=2.10", + "pre-commit>=4.5", + "pytest>=9.0", + "pytest-cookies>=0.7", + "pytest-cov>=7.0", + "ruff>=0.14.0", + "tomllint>=0.3", + "yamllint>=1.0", +] +docs = [ + "sphinx>=8.0", + "sphinx-rtd-theme>=3.0", + "sphinx-markdown-builder>=0.6", + "sphinx-autodoc-typehints>=3.5", +] + +# ==================================== +# Setuptools Configuration: +# ==================================== +[tool.setuptools.packages.find] +where = [ + "hooks", +] +include = [ + "*", +] +# ==================================== +# Black Configuration: (Formatting) +# ==================================== +[tool.black] +line-length = 88 # Maximum line length (default is 88) +target-version = ["py311"] # Target Python version(s) +skip-string-normalization = false # Whether to skip normalizing string quotes +include = '\.pyi?$' # Which files to include (regex) +exclude = ''' +/( + \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | buck-out + | build + | dist +)/ +''' +# ==================================== +# Version Bumping (bump-my-version): +# ==================================== +[tool.bumpversion] +current_version = "0.1.1" +parse = "(?P\\d+)\\.(?P\\d+)\\.(?P\\d+)" +serialize = ["{major}.{minor}.{patch}"] +search = "{current_version}" +replace = "{new_version}" +tag = false +commit = false + +[[tool.bumpversion.files]] +filename = "Makefile" +[[tool.bumpversion.files]] +filename = "README.md" +[[tool.bumpversion.files]] +filename = "docs/cookiecutter_input.json" +# ==================================== +# Codespell Configuration: +# ==================================== +[tool.codespell] +# files/patterns to ignore +skip = [ + "./changelogs/*", + "cspell.json", + "./docs/jekyll/_site", + "*.svg", + "*.css", + "*.html", + "*.lock", +] +# words to ignore globally +ignore-words-list = ["crate", "ba"] + +# extra options +check-filenames = true +quiet-level = 2 +# ==================================== +# Deptry Configuration: +# ==================================== +[tool.deptry] +ignore_notebooks = true +exclude = [ + "tests/*", + "docs/*", +] +# ==================================== +# Djlint Configuration: +# ==================================== +[tool.djlint] +profile = "jinja" +ignore = "H025,H014" +indent = 4 +max_blank_lines=2 +search_path = "." +use_gitignore=true +extension = "j2" +exclude = "docs/jekyll/_site/.*" +# ==================================== +# Ruff Configuration: +# ==================================== +[tool.ruff] +# Target Python version +target-version = "py311" +# Directories to lint and format +src = [ + "hooks", + "tests", +] + +# Exclude these paths +exclude = [ + ".venv", + "build", + "dist", + "__pycache__", + "docs", + "*.egg-info", + ".git", + ".github", + "*{{*cookiecutter.project_slug*}}*", +] +force-exclude = true +# Maximum line length +line-length = 120 +# ==================================== +# Ruff Lint Configuration: +# ==================================== +[tool.ruff.lint] +# Enable linting rules +select = [ + "W", # PyCodeStyle warnings + "E", # pycodestyle errors + "F", # pyflakes + "I", # isort (import sorting) + "N", # pep8-naming + "UP", # pyupgrade + "B", # flake8-bugbear + "A", # flake8-builtins + "C4", # comprehensions + "TID", # tidy imports + "FA", # future annotations + "PL", # pylint-style checks + "RUF", # ruff-specific +] +# Ignore specific rules +ignore = [ + "E501", # line too long (handled by formatter) + "PLR2004", # magic value comparison + "B008", # function call in default argument + "RUF200", # invalid pyproject.toml file that does not conform to the relevant specifications (PEPs) +] +# ==================================== +# Import Sorting Configuration: (Python helper scripts) +# ==================================== +[tool.ruff.lint.isort] +combine-as-imports = true +known-first-party = [ + "github-docs-cookiecutter", + "hooks" +] +# ==================================== +# Formatter Configuration: +# Ruff also formats YAML, TOML, and Markdown +# ==================================== +[tool.ruff.format] +quote-style = "double" +indent-style = "space" +line-ending = "lf" +skip-magic-trailing-comma = false +docstring-code-format = true +# ==================================== +# Mypy (type-checker) Configuration: +# ==================================== +[tool.mypy] +python_version = "3.11" +mypy_path = [ + "hooks", + "tests", +] +strict = true +warn_unused_ignores = true +warn_unused_configs = true +disallow_untyped_defs = true +ignore_missing_imports = true +# ==================================== +# Pytest Configuration: +# ==================================== +[tool.pytest.ini_options] +minversion = "7.0" +addopts = ["-v", "--maxfail=1", "-W always", "-rw", "--strict-markers"] +testpaths = [ + "tests", +] +pythonpath = [ + "hooks", +] diff --git a/tests/test_bake_project.py b/tests/test_bake_project.py new file mode 100644 index 0000000..6a93822 --- /dev/null +++ b/tests/test_bake_project.py @@ -0,0 +1,44 @@ +# test_bake_project.py for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +from pytest_cookies.plugin import Cookies + + +def test_bake_with_defaults(cookies: Cookies) -> None: + """Ensure the template bakes correctly with default context.""" + result = cookies.bake() + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + + # Optional sanity checks + project_name = result.project_path.name + assert project_name # non-empty + test_file = result.project_path / "Makefile" + assert test_file.exists() + + +def test_bake_with_custom_name(cookies: Cookies) -> None: + """Ensure custom project_name works.""" + result = cookies.bake(extra_context={"project_name": "Test Project"}) + print(result) + assert result.exit_code == 0 + assert result.exception is None + assert result.project_path.is_dir() + assert result.project_path.name == "test-project" From d2af8a322a9d2d1d691b2f7234b9161b0537beeb Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Mon, 26 Jan 2026 18:07:46 -0800 Subject: [PATCH 02/11] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/.gitignore | 74 -------- .../appspecific/com.chrome.devtools.json | 1 - docs/jekyll/Gemfile | 16 -- docs/jekyll/Makefile | 96 ---------- docs/jekyll/README.md | 34 ---- docs/jekyll/_config.yml | 164 ----------------- docs/jekyll/_includes/image-carousel.html | 64 ------- docs/jekyll/_includes/snippet_loader.html | 4 - docs/jekyll/_includes/social-bar.html | 167 ------------------ .../contribute/create-feature-request.md | 59 ------- .../_manual/contribute/create-pull-request.md | 18 -- .../_manual/contribute/developer-guide.md | 82 --------- .../_manual/contribute/git-commit-message.md | 25 --- docs/jekyll/_manual/contribute/index.md | 17 -- .../_manual/contribute/merge-pull-request.md | 61 ------- .../_manual/contribute/style-guides/index.md | 11 -- .../_manual/contribute/style-guides/python.md | 6 - .../contribute/style-guides/typescript.md | 6 - .../developer-resources/cla-privacy-policy.md | 20 --- .../jekyll/_manual/developer-resources/cla.md | 26 --- .../_manual/developer-resources/contribute.md | 31 ---- .../_manual/developer-resources/index.md | 13 -- docs/jekyll/_manual/introduction/index.md | 7 - docs/jekyll/_manual/setup-guide/index.md | 7 - .../_manual/setup-guide/requirements.md | 24 --- docs/jekyll/_manual/troubleshooting/index.md | 7 - docs/jekyll/_manual/tutorials/index.md | 7 - docs/jekyll/_manual/upgrade-guide/index.md | 13 -- docs/jekyll/_manual/whatsnew/index.md | 7 - docs/jekyll/_resources/repository-link.md | 5 - docs/jekyll/docs/cookiecutter_input.json | 43 ----- docs/jekyll/index.md | 24 --- hooks/post_gen_project.py | 2 - 34 files changed, 1 insertion(+), 1142 deletions(-) delete mode 100644 docs/jekyll/.gitignore delete mode 100644 docs/jekyll/.well-known/appspecific/com.chrome.devtools.json delete mode 100755 docs/jekyll/Gemfile delete mode 100644 docs/jekyll/Makefile delete mode 100644 docs/jekyll/README.md delete mode 100755 docs/jekyll/_config.yml delete mode 100644 docs/jekyll/_includes/image-carousel.html delete mode 100644 docs/jekyll/_includes/snippet_loader.html delete mode 100644 docs/jekyll/_includes/social-bar.html delete mode 100644 docs/jekyll/_manual/contribute/create-feature-request.md delete mode 100644 docs/jekyll/_manual/contribute/create-pull-request.md delete mode 100644 docs/jekyll/_manual/contribute/developer-guide.md delete mode 100644 docs/jekyll/_manual/contribute/git-commit-message.md delete mode 100644 docs/jekyll/_manual/contribute/index.md delete mode 100644 docs/jekyll/_manual/contribute/merge-pull-request.md delete mode 100644 docs/jekyll/_manual/contribute/style-guides/index.md delete mode 100644 docs/jekyll/_manual/contribute/style-guides/python.md delete mode 100644 docs/jekyll/_manual/contribute/style-guides/typescript.md delete mode 100644 docs/jekyll/_manual/developer-resources/cla-privacy-policy.md delete mode 100644 docs/jekyll/_manual/developer-resources/cla.md delete mode 100644 docs/jekyll/_manual/developer-resources/contribute.md delete mode 100644 docs/jekyll/_manual/developer-resources/index.md delete mode 100644 docs/jekyll/_manual/introduction/index.md delete mode 100644 docs/jekyll/_manual/setup-guide/index.md delete mode 100644 docs/jekyll/_manual/setup-guide/requirements.md delete mode 100644 docs/jekyll/_manual/troubleshooting/index.md delete mode 100644 docs/jekyll/_manual/tutorials/index.md delete mode 100644 docs/jekyll/_manual/upgrade-guide/index.md delete mode 100644 docs/jekyll/_manual/whatsnew/index.md delete mode 100644 docs/jekyll/_resources/repository-link.md delete mode 100644 docs/jekyll/docs/cookiecutter_input.json delete mode 100644 docs/jekyll/index.md diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index cd80eb6..cf35bc9 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -29,7 +29,7 @@ "python-install": false } }, - "_is_sub_template": false, + "_is_sub_template": true, "_jinja2_env_vars": { "lstrip_blocks": true, "trim_blocks": true diff --git a/docs/jekyll/.gitignore b/docs/jekyll/.gitignore deleted file mode 100644 index 1c2a791..0000000 --- a/docs/jekyll/.gitignore +++ /dev/null @@ -1,74 +0,0 @@ -# .gitignore -# ========================================= -# Project: github-docs-cookiecutter -# ========================================= - -# ========================================= -## Jekyll Ignores -# ========================================= -# Ignore the default location of the built site, and caches and metadata generated by Jekyll -_site/ -.sass-cache/ -.jekyll-cache/ -.jekyll-metadata - -# ========================================= -# Ignore folders generated by Bundler -# ========================================= -.bundle/ -vendor/ - -# ========================================= -## Default Ignores -# ========================================= - -# ========================================= -# Backup Extensions # -# ========================================= -*.bak -*.old -*.save -# ========================================= -# Emacs Tmp Extensions # -# ========================================= -*.tmp -*.tmp.* -.#* -# ========================================= -# Compiled source Extensions # -# ========================================= -*.com -*.class -*.dll -*.exe -*.o -*.so -# ========================================= -# Package Extensions # -# ========================================= -# it's better to unpack these files and commit the raw source -# git has its own built in compression methods -*.7z -*.dmg -*.gz -*.iso -*.jar -*.rar -*.tar -*.zip -# ========================================= -# Logs and databases Extensions # -# ========================================= -*.log -*.sql -*.sqlite -# ========================================= -# OS generated files # -# ========================================= -.DS_Store -.DS_Store? -._* -.Spotlight-V100 -.Trashes -ehthumbs.db -Thumbs.db diff --git a/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json deleted file mode 100644 index 0967ef4..0000000 --- a/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json +++ /dev/null @@ -1 +0,0 @@ -{} diff --git a/docs/jekyll/Gemfile b/docs/jekyll/Gemfile deleted file mode 100755 index d242ae4..0000000 --- a/docs/jekyll/Gemfile +++ /dev/null @@ -1,16 +0,0 @@ -source 'https://rubygems.org' - -# Core Dependencies -gem "faraday", "~> 2.14" -gem "faraday-retry", "~> 2.3" -gem "jekyll", "~> 4.4" -gem "just-the-docs", "~> 0.11" - -group :jekyll_plugins do - gem "jekyll-seo-tag" - gem "jekyll-sitemap" - gem "jekyll-include-cache" - gem "jekyll-github-metadata" - gem "jekyll-remote-theme" - gem "jekyll-redirect-from" -end diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile deleted file mode 100644 index d0f6035..0000000 --- a/docs/jekyll/Makefile +++ /dev/null @@ -1,96 +0,0 @@ -# Makefile -# ========================================= -# Project: github-docs for github-docs-cookiecutter -# ========================================= - -# -------------------------------------------------- -# โš™๏ธ Environment Settings -# -------------------------------------------------- -SHELL := /bin/bash -.SHELLFLAGS := -O globstar -c -# If V is set to '1' or 'y' on the command line, -# AT will be empty (verbose). Otherwise, AT will -# contain '@' (quiet by default). The '?' is a -# conditional assignment operator: it only sets V -# if it hasn't been set externally. -V ?= 0 -ifeq ($(V),0) - AT = @ -else - AT = -endif -# Detect if we are running inside GitHub Actions CI. -# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. -# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. -ifeq ($(GITHUB_ACTIONS),true) -CI := 1 -else -CI := 0 -endif -# Define a reusable CI-safe runner -define run_ci_safe = -( $1 || [ "$(CI)" != "1" ] ) -endef -# -------------------------------------------------- -# โš™๏ธ Build Settings -# -------------------------------------------------- -PACKAGE_NAME = "github-docs-cookiecutter" -AUTHOR = "Jared Cook" -VERSION = "0.1.1" -PUBLISHDIR ?= -# -------------------------------------------------- -# ๐Ÿ“š Documentation (Sphinx + Jekyll) -# -------------------------------------------------- -RUBY_INSTALL := bundle install -JEKYLL_BUILD := bundle exec jekyll build --quiet -JEKYLL_CLEAN := bundle exec jekyll clean -JEKYLL_SERVE := bundle exec jekyll serve -# -------------------------------------------------- -.PHONY: all ruby-install jekyll jekyll-serve build run clean help -# -------------------------------------------------- -# Default: -# -------------------------------------------------- -all: ruby-install build -# -------------------------------------------------- -# โ™ฆ๏ธ Ruby -# -------------------------------------------------- -ruby-install: - $(AT)$(RUBY_INSTALL) -# -------------------------------------------------- -# ๐Ÿ“š Documentation (Jekyll) -# -------------------------------------------------- -jekyll: - $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“š..." - $(AT)$(JEKYLL_BUILD) - $(AT)echo "โœ… Full documentation build complete!" - -jekyll-serve: - $(AT)echo "๐Ÿš€ Starting Jekyll development server..." - $(AT)$(JEKYLL_SERVE) - -build: jekyll -run: jekyll-serve -# -------------------------------------------------- -# ๐Ÿงน Clean artifacts -# -------------------------------------------------- -clean: - $(AT)echo "๐Ÿงน Cleaning Jekyll build artifacts..." - $(AT)$(call run_ci_safe,$(JEKYLL_CLEAN)) - $(AT)echo "โœ… Cleaned Jekyll build artifacts." -# -------------------------------------------------- -# Help -# -------------------------------------------------- -help: - $(AT)echo "๐Ÿ“ฆ $(PACKAGE_NAME) github documentation Makefile" - $(AT)echo " author: $(PACKAGE_AUTHOR)" - $(AT)echo " version: $(PACKAGE_VERSION)" - $(AT)echo "" - $(AT)echo "Usage:" - $(AT)echo " make ruby-install Installs Gemfile packages." - $(AT)echo " make build Generate Jekyll documentation" - $(AT)echo " make run Serve Jekyll site locally" - $(AT)echo " make clean Clean Jekyll build artifacts" - $(AT)echo " make all Run make (build)" - $(AT)echo "Options:" - $(AT)echo " V=1 Enable verbose output (show all commands being executed)" - $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md deleted file mode 100644 index 0fc5cca..0000000 --- a/docs/jekyll/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# {{ site.title }} - -[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE) - -__Author:__ {{ site.author }} -__Version:__ {{ site.version }} - -## Overview -{{ site.description }} - -__CI/CD Check List:__ -* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg) -* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg) -* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg) -* ![security-audit]({{ site.repo_url }}/actions/workflows/security-audit.yml/badge.svg) -* ![spellcheck]({{ site.repo_url }}/actions/workflows/spellcheck.yml/badge.svg) -* ![tests]({{ site.repo_url }}/actions/workflows/tests.yml/badge.svg) -* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) - -*** - -## Usage Examples - -## Advance Examples - -## Development Strategy - -## License -{{ cookiecutter.copyright }} - -This project is licensed under the __{{ cookiecutter.license }} License__. -See the [LICENSE](LICENSE) file for the full license text. - -SPDX-License-Identifier: {{ cookiecutter.license }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml deleted file mode 100755 index f8410b2..0000000 --- a/docs/jekyll/_config.yml +++ /dev/null @@ -1,164 +0,0 @@ -# github-docs-cookiecutter Documentation ---- -title: "github-docs-cookiecutter" -author: "Jared Cook" -version: "0.1.1" -timezone: "America/Los_Angeles" -description: "Github docs cookiecutter template generation." -remote_theme: "pmarsceill/just-the-docs" -ga_tracking: "G-C7PWLWSHB9" - -repo_url: "https://github.com/jcook3701/github-docs-cookiecutter" -repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/None/" - -repository: "jcook3701/github-docs-cookiecutter" - -# Specifies the site's subpath for correct URL generation -baseurl: "/github-docs-cookiecutter" - -collections: - manual: - output: true - permalink: /:collection/:path - - resources: - output: true - permalink: /:collection/:path - -just_the_docs: - collections: - manual: - name: Manual - nav_fold: true - nav_exclude: false - - resources: - name: "External Links" - nav_fold: false - nav_exclude: false - -plugins: - - jekyll-remote-theme - - jekyll-redirect-from - - jekyll-seo-tag - - jekyll-github-metadata - - jekyll-include-cache - - jekyll-sitemap - -# Author Remote User Accounts -# twitter_username: "" -github_username: "jcook3701" -linkedin_usercode: "jared-cook-b3585a114" -buymeacoffee_username: "jcook3701" - -# carousel_images: -# - /assets/images/ -# - /assets/images/ -# - /assets/images/ - -# Set a path/url to a logo that will be displayed instead of the title -# logo: /assets/images/icon128.png - -# Enable or disable the site search -search_enabled: true - -# For copy button on code -enable_copy_code_button: true - -# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in -mermaid: - # Version of mermaid library - # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ - version: "9.1.6" - # Note: Put any additional configuration, such as setting the theme, - # in _includes/mermaid_config.js. See also docs/ui-components/code. - # Note: To load mermaid from a local library, also use the `path` key - # to specify the location of the library; e.g. for (v10+): - # path: "/assets/js/mermaid.esm.min.mjs" for (- - Copyright (c) 2025-2026, Jared Cook. Distributed by an - - AGPL-3.0-or-later license. - - - -## Footer last edited timestamp -# show or hide edit time - page must have `last_modified_date` defined in the frontmatter -last_edit_timestamp: true -# uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html -last_edit_time_format: >- - %b %e %Y at %I:%M %p -## Footer "Edit this page on GitHub" link text -# show or hide edit this page link -gh_edit_link: true -gh_edit_link_text: "Edit this page on GitHub" -# the github URL for your repo -gh_edit_repository: >- - https://github.com/jcook3701/github-docs-cookiecutter -# the branch that your docs is served from -gh_edit_branch: "master" -# the source that your files originate from -gh_edit_source: docs -# "tree" or "edit" if you want the user to jump into the editor immediately -gh_edit_view_mode: "tree" - -# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define -callouts_level: quiet # or loud -callouts: - highlight: - color: yellow - important: - title: Important - color: blue - new: - title: New - color: green - note: - title: Note - color: purple - warning: - title: Warning - color: red - -kramdown: - auto_ids: true - -include: - - .well-known - -# Exclude files/folders from Jekyll processing -exclude: - - node_modules - - .DS_Store - - Gemfile - - Gemfile.lock - -# Optional SEO metadata -seo: - title: "github-docs-cookiecutter Documentation" - description: "Full code documentation for the github-docs-cookiecutter project" diff --git a/docs/jekyll/_includes/image-carousel.html b/docs/jekyll/_includes/image-carousel.html deleted file mode 100644 index f74f777..0000000 --- a/docs/jekyll/_includes/image-carousel.html +++ /dev/null @@ -1,64 +0,0 @@ -
- -
- {% assign slides = site.carousel_images %} {% for image in slides %} {% if - image.src %} - {{ image.caption }} - {% else %} - - {% endif %} {% endfor %} -
- -
- - - - diff --git a/docs/jekyll/_includes/snippet_loader.html b/docs/jekyll/_includes/snippet_loader.html deleted file mode 100644 index 6765a0a..0000000 --- a/docs/jekyll/_includes/snippet_loader.html +++ /dev/null @@ -1,4 +0,0 @@ - diff --git a/docs/jekyll/_includes/social-bar.html b/docs/jekyll/_includes/social-bar.html deleted file mode 100644 index 9dd1a65..0000000 --- a/docs/jekyll/_includes/social-bar.html +++ /dev/null @@ -1,167 +0,0 @@ - -
-
    - {% if site.twitter_username %} -
  • - -
    • - {% endif %} - - {% if site.linkedin_usercode %} -
  • - - - -
    • - {% endif %} - - {% if site.github_username %} -
  • - - - -
    • - {% endif %} - - - {% if site.buymeacoffee_username %} -
  • - - - -
    • - {% endif %} -
-
- - diff --git a/docs/jekyll/_manual/contribute/create-feature-request.md b/docs/jekyll/_manual/contribute/create-feature-request.md deleted file mode 100644 index 8c4291b..0000000 --- a/docs/jekyll/_manual/contribute/create-feature-request.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: Create a feature request -nav_order: 1 -parent: Contribute ---- -## Create a feature request - -Feature requests help us understand what you need from github-docs-cookiecutter. This document guides you through writing effective feature requests that help maintainers understand your needs and prioritize improvements. - -## Before you begin - -We're excited to hear your ideas! Before you submit a feature request, consider these resources: - -- Read the [Code of Conduct](../CODE_OF_CONDUCT.md) to understand our community guidelines. -- Search [existing feature requests](https://github.com/jcook3701/github-docs-cookiecutter/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Ffeature-request) to see if someone already suggested something similar. - -## Your first feature request - -When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why. - - - -## Best practices for feature requests - -Follow these guidelines to increase the chances of your feature request being accepted: - -### Keep it focused - -Request one feature at a time. If you have multiple ideas, create separate feature requests for each one. This makes it easier to discuss, prioritize, and implement each feature independently. - -### Research first - -Before submitting, search for similar requests. If you find an existing request that's close to your idea, add your use case and context to that discussion instead of creating a duplicate. - -### Provide context - -The more context you provide, the better maintainers can understand your needs. Include: - -- Your environment or setup (which data sources, plugins, or features you're using) -- Your workflow or process -- Why this matters to you -- Any workarounds you've tried - -### Be open to alternatives - -Maintainers might suggest different approaches to solve your problem. Be open to these alternatives as they might be easier to implement or more maintainable in the long term. - -### Stay engaged - -After submitting your feature request, monitor the discussion. Answer questions from maintainers and provide clarification when needed. This helps move your request forward. - -## Contributing the feature yourself - -If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link _manual/contribute/create-pull-request.md %}). - -We welcome community contributions and appreciate your help making github-docs-cookiecutter better! diff --git a/docs/jekyll/_manual/contribute/create-pull-request.md b/docs/jekyll/_manual/contribute/create-pull-request.md deleted file mode 100644 index 11a9b6c..0000000 --- a/docs/jekyll/_manual/contribute/create-pull-request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default -title: Create a pull request -nav_order: 1 -parent: Contribute ---- - -## Create a pull request - -Every contribution to github-docs-cookiecutter's software begins with a [pull request](https://help.github.com/en/articles/about-pull-requests/). This document guides you through the process of creating a PR. - -## Before you begin - -We know you're excited to create your first pull request. Before we get started, read these resources first: - -- Get started [contributing to github-docs-cookiecutter]({{ site.repo_url }}/CONTRIBUTING.md). -- Make sure your code follows the relevant [style guides]({% link _manual/contribute/style-guides/index.md %}). -- It's recommended you [set up precommit hooks]({% link _manual/contribute/developer-guide.md %}) to auto-format when you commit. diff --git a/docs/jekyll/_manual/contribute/developer-guide.md b/docs/jekyll/_manual/contribute/developer-guide.md deleted file mode 100644 index cc2a82f..0000000 --- a/docs/jekyll/_manual/contribute/developer-guide.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -layout: default -title: Developer Guide -nav_order: 1 -parent: Contribute ---- - -## Developer guide - -This guide helps you get started developing github-docs-cookiecutter. - -## Development Strategy - -All Makefile commands are used in __ci/cd__ to ensure that if they pass locally they should also pass once pushed to github. - -### ๐Ÿ๏ธ Build environment (.venv) - -``` shell -$ make install -``` - -### ๐Ÿงฌ Dependency Management (deptry) - -```shell -$ make dependency-check -``` - -### ๐Ÿ›ก๏ธ Security Audit (pip-audit) - -```shell -$ make security -``` - -### ๐ŸŽจ Formatting (black) - -```shell -$ make format-check -``` - -```shell -$ make format-fix -``` - -### ๐Ÿ” Linting (jinja2-cli, ruff, tomllint, & yaml-lint) - -``` shell -$ make lint-check -``` - -``` shell -$ make lint-fix -``` - -### ๐ŸŽ“ Spellchecking (codespell) - -```shell -$ make spellcheck -``` - -### ๐Ÿง  Typechecking (mypy) - -``` shell -$ make typecheck -``` - -### ๐Ÿงช Testing (pytest) - -``` shell -$ make test -``` - -### ๐Ÿš€ Release (git tag) - -```shell -$ make release -``` - -### โ“ Build Help - -``` shell -$ make help -``` diff --git a/docs/jekyll/_manual/contribute/git-commit-message.md b/docs/jekyll/_manual/contribute/git-commit-message.md deleted file mode 100644 index 07ad904..0000000 --- a/docs/jekyll/_manual/contribute/git-commit-message.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: "Git Commit Message" -nav_order: 1 -parent: Contribute ---- -## Git Commit Message Format Guide - -Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by pre-commit. - -__example:__ - -```shell -[optional scope]: - -[optional body] - -[optional footer(s)] -``` - -* ``````: A required noun that describes the nature of the change. -* ```[optional scope]```: An optional phrase within parentheses that specifies the part of the codebase being affected (e.g., fix(parser):). -* ``````: A required short, imperative-mood summary of the changes. -* ```[optional body]```: A longer description providing additional context and "what and why" details. -* ```[optional footer(s)]```: Used for adding meta-information, such as issue references (Fixes #123) or indicating breaking changes. diff --git a/docs/jekyll/_manual/contribute/index.md b/docs/jekyll/_manual/contribute/index.md deleted file mode 100644 index 55d96c3..0000000 --- a/docs/jekyll/_manual/contribute/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: Contribute -nav_order: 1 -has_children: true ---- -## Contribute to the github-docs-cookiecutter project - -We're excited that you're considering making a contribution to the github-docs-cookiecutter project! This is the place to find guides for contributors to our open-source project. - -These are some good resources to explore for developers: - -[Create a pull request]({% link _manual/contribute/create-pull-request.md %}) -[Create a feature request]({% link _manual/contribute/create-feature-request.md %}) -[Developer guide]({% link _manual/contribute/developer-guide.md %}) -[Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) -Find style guides for the github-docs-cookiecutter software project: diff --git a/docs/jekyll/_manual/contribute/merge-pull-request.md b/docs/jekyll/_manual/contribute/merge-pull-request.md deleted file mode 100644 index af1e1de..0000000 --- a/docs/jekyll/_manual/contribute/merge-pull-request.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: Merge a pull request -nav_order: 1 -parent: Contribute ---- -## Merge a pull request - -When a pull request has been reviewed and approved by at least one person and all checks have passed, then it's time to merge the pull request. - -## Who is expected to merge a pull request? - -Maintainers are responsible for merging all pull requests. If a maintainer has opened a pull request, then the general rule is that the same maintainer merges the pull request. If a non-maintainer has opened a pull request, then it's suggested that one of the maintainers who reviews the pull request should merge the pull request. - -## Checklist of considerations - -Consider (and ask about) the items on the following checklist before merging a pull request: - -- Is it reviewed and approved? -- Have all checks passed? -- Does it have a proper pull request title? -- Does it need to be added to the changelog (release notes)? -- Does it need backporting? - -## Before merge - -Before actually merging a pull request, consider the following things: - -### Status checks - -Before you can merge a pull request, it must have a review approval, and all the required status checks must pass. - -### Format the pull request title - - - -### Changelog (automated) - -## Doing the actual merge - -The best time to actually merge the pull request varies from case to case. All commits in a pull request are squashed. - -You can change the commit message before merging. Please remember that developers might use the commit information for tasks like reviewing changes of files, doing Git blame, and resolving merge conflicts. - -While there aren't formal best practices around this process, you can consider the following guidance: - -**Do:** - -- Make sure the pull request title is formatted properly before merging. Doing so automatically gives you a good and short summary of the commit. -- Leave `Co-authored-by:` lines as is so that co-authors are credited for the contribution. -- Remove any commit information that doesn't bring any context to the change. - -**Consider:** - -- Keep any references to issues that the pull request fixes, closes, or references. Doing this allows cross-reference between the commit and referenced issue or issues. - -To finalize the merge, click the **Confirm squash and merge** button. - -## After the merge - -Make sure to close any referenced or related issues. We recommend that you assign the same milestone on the issues that the pull request fixes or closes, but this isn't required. diff --git a/docs/jekyll/_manual/contribute/style-guides/index.md b/docs/jekyll/_manual/contribute/style-guides/index.md deleted file mode 100644 index f457906..0000000 --- a/docs/jekyll/_manual/contribute/style-guides/index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: default -title: "Style Guide" -nav_order: 1 -has_children: true -parent: Contribute ---- - -## Style Guides -* [Python](python.md) style guide. -* [Typescript](typescript.md) style guide. diff --git a/docs/jekyll/_manual/contribute/style-guides/python.md b/docs/jekyll/_manual/contribute/style-guides/python.md deleted file mode 100644 index 0201964..0000000 --- a/docs/jekyll/_manual/contribute/style-guides/python.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -title: "Python Style Guide" -nav_order: 1 -parent: "Style Guide" ---- diff --git a/docs/jekyll/_manual/contribute/style-guides/typescript.md b/docs/jekyll/_manual/contribute/style-guides/typescript.md deleted file mode 100644 index 9dea0e0..0000000 --- a/docs/jekyll/_manual/contribute/style-guides/typescript.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -title: "Typescript Style Guide" -nav_order: 1 -parent: "Style Guide" ---- diff --git a/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md deleted file mode 100644 index a98d984..0000000 --- a/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -title: CLA Privacy Policy -nav_order: 1 -parent: "Developer Resources" ---- -## github-docs-cookiecutter CLA Privacy Policy - -## Collection and storage of personal data and the nature and purpose of their use - -Most Project business is conducted publicly, and privacy of submitted information is not expected. - -Specifically, information is exchanged via public email lists and public code repositories. Public code repositories use patch submission, pull requests, discussions, and bug reports. None of these tools keep submitted information private. They are publicly accessible and archived in multiple locations around the world, by the Project and third parties. - -You should never submit personally identifiable information (PII) via any of these mechanisms. - - diff --git a/docs/jekyll/_manual/developer-resources/cla.md b/docs/jekyll/_manual/developer-resources/cla.md deleted file mode 100644 index 838240d..0000000 --- a/docs/jekyll/_manual/developer-resources/cla.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: Contributor License Agreement (CLA) -nav_order: 1 -parent: "Developer Resources" ---- -## github-docs-cookiecutter Contributor License Agreement ("Agreement") V1.0 - -This agreement is based on the Apache Software Foundation Individual Contributor License Agreement ("Agreement") V2.2 - -Thank you for your interest in __The github-docs-cookiecutter project by Jared Cook,__ dba Jared Cook (the "Project"). To clarify the intellectual property license granted with Contributions from any person or entity, the Project must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of the Project and its users. It does not change your rights to use your own Contributions for any other purpose. - -You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to the Project. In return, the Project shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its nonprofit status and bylaws in effect at the time of the Contribution. Except for the license granted herein to the Project and recipients of software distributed by the Project, You reserve all right, title, and interest in and to Your Contributions. - -1. __Definitions. "You"__ (or __"Your"__) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Project. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Project for inclusion in, or documentation of, any of the products owned or managed by the Project (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Project or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." -2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. -3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. -4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Project, or that your employer has executed a separate Corporate CLA with the Project. -5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. -6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. -7. Should You wish to submit work that is not Your original creation, You may submit it to the Project separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". -8. You agree to notify the Project of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. - -This is a legal contract containing Personally Identifiable Information. -Please refer to our [cla-privacy-policy](cla-privacy-policy.md) for the policy -governing how this information is used and shared. diff --git a/docs/jekyll/_manual/developer-resources/contribute.md b/docs/jekyll/_manual/developer-resources/contribute.md deleted file mode 100644 index 0d01a0c..0000000 --- a/docs/jekyll/_manual/developer-resources/contribute.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: Contribute -nav_order: 2 -parent: "Developer Resources" ---- -## Contribute to github-docs-cookiecutter - -This page lists resources for developers who want to contribute to the github-docs-cookiecutter ecosystem. - -## Make technical contributions - -### Contribute code to github-docs-cookiecutter - -* [Contributing to github-docs-cookiecutter]() -* [Developer guide]() -* [Create a pull request] walks you through preparing a clear, descriptive pull request. -* Browse all [issues](https://github.com/jcook3701/github-docs-cookiecutter/issues/new) to find a good first task. You can also filter by [help wanted](). - -### Contribute without code - -* Report a bug with the [bug report template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=01-bug-report.yml) and include steps to reproduce. -* Submit a [feature request](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature-request.yml) to propose improvements. -* Report security vulnerabilities following our [security policy](). - -### Best practices and style - -Our [style guides]() outline github-docs-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! - * [Python style guide](). - * [Typescript style guide](). - * [YAML style guide](). diff --git a/docs/jekyll/_manual/developer-resources/index.md b/docs/jekyll/_manual/developer-resources/index.md deleted file mode 100644 index 2f065ab..0000000 --- a/docs/jekyll/_manual/developer-resources/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: default -title: "Developer Resources" -nav_order: 1 -has_children: true ---- -## Developer resources - -This section of the documentation contains additional resources for developers and contributors. - -## Contribute to github-docs-cookiecutter - -Refer to the [Contribute to github-docs-cookiecutter]() guide to learn the various ways you can contribute to github-docs-cookiecutter. Read the [github-docs-cookiecutter Contributor License Agreement]() before making any contribution. diff --git a/docs/jekyll/_manual/introduction/index.md b/docs/jekyll/_manual/introduction/index.md deleted file mode 100644 index 27d594b..0000000 --- a/docs/jekyll/_manual/introduction/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: Introduction -nav_order: 1 -has_children: true ---- -## Introduction to github-docs-cookiecutter diff --git a/docs/jekyll/_manual/setup-guide/index.md b/docs/jekyll/_manual/setup-guide/index.md deleted file mode 100644 index c4f2d7c..0000000 --- a/docs/jekyll/_manual/setup-guide/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: "Setup Guide" -nav_order: 1 -has_children: true ---- -## github-docs-cookiecutter Setup diff --git a/docs/jekyll/_manual/setup-guide/requirements.md b/docs/jekyll/_manual/setup-guide/requirements.md deleted file mode 100644 index 7bf7a1d..0000000 --- a/docs/jekyll/_manual/setup-guide/requirements.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default -title: Requirements -nav_order: 1 -parent: "Setup Guide" ---- - -## github-docs-cookiecutter Requirements - -1. Python 3.11 - ```shell - $ sudo apt install python3.11 - ``` -2. [rustup](https://rust-lang.org/tools/install/) - __Note:__ I found that it is easiest to use rustup to manage rustc and cargo but this is not required. - __Example:__ Install rustup with the following: - ```shell - $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - ``` -3. [git-cliff](https://git-cliff.org/) - __Note:__ git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. - ```shell - $ cargo install git-cliff - ``` diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md deleted file mode 100644 index df710b0..0000000 --- a/docs/jekyll/_manual/troubleshooting/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: Troubleshooting -nav_order: 1 -has_children: true ---- -## Troubleshooting github-docs-cookiecutter diff --git a/docs/jekyll/_manual/tutorials/index.md b/docs/jekyll/_manual/tutorials/index.md deleted file mode 100644 index 937baa9..0000000 --- a/docs/jekyll/_manual/tutorials/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: Tutorials -nav_order: 1 -has_children: true ---- -## github-docs-cookiecutter Tutorials diff --git a/docs/jekyll/_manual/upgrade-guide/index.md b/docs/jekyll/_manual/upgrade-guide/index.md deleted file mode 100644 index afbc7a7..0000000 --- a/docs/jekyll/_manual/upgrade-guide/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -layout: default -title: "Upgrade Guide" -nav_order: 1 -has_children: true ---- -## github-docs-cookiecutter Upgrade Guide - -### ๐Ÿช Project Updater (cookiecutter_project_upgrader) - -```shell -$ source .venv/bin/activate && cookiecutter_project_upgrader --context-file ./docs/cookiecutter_input.json --upgrade-branch main -``` diff --git a/docs/jekyll/_manual/whatsnew/index.md b/docs/jekyll/_manual/whatsnew/index.md deleted file mode 100644 index 9ea9be5..0000000 --- a/docs/jekyll/_manual/whatsnew/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -layout: default -title: "What's New" -nav_order: 1 -has_children: true ---- -## What's new in github-docs-cookiecutter diff --git a/docs/jekyll/_resources/repository-link.md b/docs/jekyll/_resources/repository-link.md deleted file mode 100644 index 98d326c..0000000 --- a/docs/jekyll/_resources/repository-link.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "github-docs-cookiecutter on GitHub ๐Ÿ”—" -nav_order: 1 -redirect_to: "https://github.com/jcook3701/github-docs-cookiecutter" ---- diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json deleted file mode 100644 index 8f6e385..0000000 --- a/docs/jekyll/docs/cookiecutter_input.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "__year_range": "2025-2026", - "_checkout": null, - "_copy_without_render": [ - "README.md", - "_includes/*" - ], - "_extensions": [ - "jinja2.ext.do", - "jinja2.ext.loopcontrols", - "jinja2_time.TimeExtension" - ], - "_is_sub_template": true, - "_jinja2_env_vars": { - "lstrip_blocks": true, - "trim_blocks": true - }, - "_output_dir": "/home/jcook/Documents/git_repo/github-doc-cookiecutter/.git/cookiecutter/github-docs-cookiecutter/docs/_tmp_docs", - "_repo_dir": "/home/jcook/.cookiecutters/github-docs-cookiecutter", - "_template": "https://github.com/jcook3701/github-docs-cookiecutter.git", - "author": "Jared Cook", - "buymeacoffee_username": "jcook3701", - "company": null, - "contribution_model": "CLA", - "copyright": "Copyright (c) 2025-2026, Jared Cook", - "current_year": "2026", - "description": "Github docs cookiecutter template generation.", - "email": "jcook3701+github@gmail.com", - "ga_tracking": "G-C7PWLWSHB9", - "github_org": null, - "github_username": "jcook3701", - "license": "AGPL-3.0-or-later", - "linkedin_usercode": "jared-cook-b3585a114", - "project_name": "github-docs-cookiecutter", - "project_slug": "github-docs-cookiecutter", - "publication_year": "2025", - "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", - "template_type": "cookiecutter", - "theme": "pmarsceill/just-the-docs", - "timezone": "America/Los_Angeles", - "twitter_username": "", - "version": "0.1.1" -} diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md deleted file mode 100644 index d675500..0000000 --- a/docs/jekyll/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default -title: github-docs-cookiecutter -nav_order: 1 -description: Github docs cookiecutter template generation. ---- - - - -{% include snippet_loader.html %} - -{% if site.carousel_images %} - {% include image-carousel.html %} -{% endif %} - -{% include_relative README.md %} - -## โ˜• Support Me -If you enjoy this project, please consider buying me a coffee or making a code contribution. - -## Social Links - -{% include social-bar.html %} - diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index 1518627..6bf4700 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -21,7 +21,6 @@ from nutrimatic.core import make from nutrimatic.hooks.post_gen_logic import ( - generate_cliff_changelog_dirs, generate_docs_templates, get_make_cmds, ) @@ -38,7 +37,6 @@ def main() -> None: # Access cookiecutter context safely context = json.loads("""{{ cookiecutter | jsonify }}""") generate_docs_templates(context) - generate_cliff_changelog_dirs() # Run make commands to get project seeded make_cmds: list[str] = get_make_cmds(context) From d0bdd4fbfd560ef7368b9f0fd9849217c855dace Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Mon, 26 Jan 2026 21:20:42 -0800 Subject: [PATCH 03/11] Update template --- .github/workflows/cla.yml | 4 ++-- docs/cookiecutter_input.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index b479e9d..6f9c858 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -47,9 +47,9 @@ jobs: # PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} with: signed-commit-message: 'chore: $contributorName has signed the CLA' path-to-signatures: 'signatures/version1/cla.json' - path-to-document: 'https://github.com/${{ github.repository }}/blob/main/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document + path-to-document: 'https://github.com/${{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document # branch should not be protected - branch: "main" + branch: "master" allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index cf35bc9..be6da46 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -15,7 +15,7 @@ "__year_range": "2025-2026", "_checkout": "main", "_copy_without_render": [], - "_default_branch": "main", + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", "jinja2.ext.loopcontrols" From 4faa8f5eb9242d4b1d36229d5c523ddbf3f8577d Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Mon, 26 Jan 2026 22:43:36 -0800 Subject: [PATCH 04/11] Update template --- .github/workflows/cla.yml | 3 ++- .jinja-runtime.json | 10 +++------- docs/cookiecutter_input.json | 1 + 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index 6f9c858..cfd292a 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -44,7 +44,8 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # the below token should have repo scope and must be manually added by you in the repository's secret # This token is required only if you have configured to store the signatures in a remote repository/organization - # PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} with: + # PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + with: signed-commit-message: 'chore: $contributorName has signed the CLA' path-to-signatures: 'signatures/version1/cla.json' path-to-document: 'https://github.com/${{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document diff --git a/.jinja-runtime.json b/.jinja-runtime.json index 4cc19f4..b7cd767 100644 --- a/.jinja-runtime.json +++ b/.jinja-runtime.json @@ -7,12 +7,8 @@ ], "base_dir": "." }, - "env": { - "globals": { - "cookiecutter": { - "project_slug": "example_project", - "chosen_license": "MIT" - } - } + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true } } diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index be6da46..f93db28 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -48,6 +48,7 @@ "description": "Github docs cookiecutter template generation.", "email": "jcook3701+github@gmail.com", "ga_tracking": "G-C7PWLWSHB9", + "github_io": "https://jcook3701.github.io/github-docs-cookiecutter", "github_org": null, "github_username": "jcook3701", "license": "AGPL-3.0-or-later", From 0223894ff8c02aa5d78962d0e7db422298cd9adc Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Tue, 27 Jan 2026 00:16:03 -0800 Subject: [PATCH 05/11] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/.gitignore | 74 ++++++++ .../appspecific/com.chrome.devtools.json | 1 + docs/jekyll/Gemfile | 21 +++ docs/jekyll/Makefile | 96 ++++++++++ docs/jekyll/README.md | 41 +++++ docs/jekyll/_config.yml | 164 +++++++++++++++++ docs/jekyll/_includes/image-carousel.html | 64 +++++++ docs/jekyll/_includes/snippet_loader.html | 4 + docs/jekyll/_includes/social-bar.html | 167 ++++++++++++++++++ .../contribute/create-feature-request.md | 59 +++++++ .../_manual/contribute/create-pull-request.md | 18 ++ .../_manual/contribute/developer-guide.md | 82 +++++++++ .../_manual/contribute/git-commit-message.md | 25 +++ docs/jekyll/_manual/contribute/index.md | 21 +++ .../_manual/contribute/merge-pull-request.md | 61 +++++++ .../_manual/contribute/style-guides/index.md | 12 ++ .../_manual/contribute/style-guides/python.md | 7 + .../contribute/style-guides/typescript.md | 7 + .../_manual/contribute/style-guides/yaml.md | 7 + .../developer-resources/cla-privacy-policy.md | 20 +++ .../jekyll/_manual/developer-resources/cla.md | 26 +++ .../_manual/developer-resources/contribute.md | 32 ++++ .../_manual/developer-resources/index.md | 13 ++ .../_manual/introduction/getting-started.md | 7 + docs/jekyll/_manual/introduction/index.md | 7 + docs/jekyll/_manual/setup-guide/index.md | 9 + .../_manual/setup-guide/requirements.md | 30 ++++ docs/jekyll/_manual/troubleshooting/index.md | 7 + docs/jekyll/_manual/tutorials/index.md | 7 + docs/jekyll/_manual/upgrade-guide/index.md | 13 ++ docs/jekyll/_manual/whatsnew/index.md | 7 + docs/jekyll/_resources/repository-link.md | 5 + docs/jekyll/docs/cookiecutter_input.json | 44 +++++ docs/jekyll/index.md | 24 +++ hooks/post_gen_project.py | 2 + 36 files changed, 1185 insertions(+), 1 deletion(-) create mode 100644 docs/jekyll/.gitignore create mode 100644 docs/jekyll/.well-known/appspecific/com.chrome.devtools.json create mode 100755 docs/jekyll/Gemfile create mode 100644 docs/jekyll/Makefile create mode 100644 docs/jekyll/README.md create mode 100755 docs/jekyll/_config.yml create mode 100644 docs/jekyll/_includes/image-carousel.html create mode 100644 docs/jekyll/_includes/snippet_loader.html create mode 100644 docs/jekyll/_includes/social-bar.html create mode 100644 docs/jekyll/_manual/contribute/create-feature-request.md create mode 100644 docs/jekyll/_manual/contribute/create-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/developer-guide.md create mode 100644 docs/jekyll/_manual/contribute/git-commit-message.md create mode 100644 docs/jekyll/_manual/contribute/index.md create mode 100644 docs/jekyll/_manual/contribute/merge-pull-request.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/index.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/python.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/typescript.md create mode 100644 docs/jekyll/_manual/contribute/style-guides/yaml.md create mode 100644 docs/jekyll/_manual/developer-resources/cla-privacy-policy.md create mode 100644 docs/jekyll/_manual/developer-resources/cla.md create mode 100644 docs/jekyll/_manual/developer-resources/contribute.md create mode 100644 docs/jekyll/_manual/developer-resources/index.md create mode 100644 docs/jekyll/_manual/introduction/getting-started.md create mode 100644 docs/jekyll/_manual/introduction/index.md create mode 100644 docs/jekyll/_manual/setup-guide/index.md create mode 100644 docs/jekyll/_manual/setup-guide/requirements.md create mode 100644 docs/jekyll/_manual/troubleshooting/index.md create mode 100644 docs/jekyll/_manual/tutorials/index.md create mode 100644 docs/jekyll/_manual/upgrade-guide/index.md create mode 100644 docs/jekyll/_manual/whatsnew/index.md create mode 100644 docs/jekyll/_resources/repository-link.md create mode 100644 docs/jekyll/docs/cookiecutter_input.json create mode 100644 docs/jekyll/index.md diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index f93db28..baa0ac4 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -29,7 +29,7 @@ "python-install": false } }, - "_is_sub_template": true, + "_is_sub_template": false, "_jinja2_env_vars": { "lstrip_blocks": true, "trim_blocks": true diff --git a/docs/jekyll/.gitignore b/docs/jekyll/.gitignore new file mode 100644 index 0000000..1c2a791 --- /dev/null +++ b/docs/jekyll/.gitignore @@ -0,0 +1,74 @@ +# .gitignore +# ========================================= +# Project: github-docs-cookiecutter +# ========================================= + +# ========================================= +## Jekyll Ignores +# ========================================= +# Ignore the default location of the built site, and caches and metadata generated by Jekyll +_site/ +.sass-cache/ +.jekyll-cache/ +.jekyll-metadata + +# ========================================= +# Ignore folders generated by Bundler +# ========================================= +.bundle/ +vendor/ + +# ========================================= +## Default Ignores +# ========================================= + +# ========================================= +# Backup Extensions # +# ========================================= +*.bak +*.old +*.save +# ========================================= +# Emacs Tmp Extensions # +# ========================================= +*.tmp +*.tmp.* +.#* +# ========================================= +# Compiled source Extensions # +# ========================================= +*.com +*.class +*.dll +*.exe +*.o +*.so +# ========================================= +# Package Extensions # +# ========================================= +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip +# ========================================= +# Logs and databases Extensions # +# ========================================= +*.log +*.sql +*.sqlite +# ========================================= +# OS generated files # +# ========================================= +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db diff --git a/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/docs/jekyll/.well-known/appspecific/com.chrome.devtools.json @@ -0,0 +1 @@ +{} diff --git a/docs/jekyll/Gemfile b/docs/jekyll/Gemfile new file mode 100755 index 0000000..0c08968 --- /dev/null +++ b/docs/jekyll/Gemfile @@ -0,0 +1,21 @@ +source 'https://rubygems.org' + +# Core Dependencies +gem "faraday", "~> 2.14" +gem "faraday-retry", "~> 2.3" +gem "jekyll", "~> 4.4" +gem "just-the-docs", "~> 0.11" + +gem "bigdecimal" +gem "csv" +gem "logger" +gem "base64" + +group :jekyll_plugins do + gem "jekyll-seo-tag" + gem "jekyll-sitemap" + gem "jekyll-include-cache" + gem "jekyll-github-metadata" + gem "jekyll-remote-theme" + gem "jekyll-redirect-from" +end diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile new file mode 100644 index 0000000..d0f6035 --- /dev/null +++ b/docs/jekyll/Makefile @@ -0,0 +1,96 @@ +# Makefile +# ========================================= +# Project: github-docs for github-docs-cookiecutter +# ========================================= + +# -------------------------------------------------- +# โš™๏ธ Environment Settings +# -------------------------------------------------- +SHELL := /bin/bash +.SHELLFLAGS := -O globstar -c +# If V is set to '1' or 'y' on the command line, +# AT will be empty (verbose). Otherwise, AT will +# contain '@' (quiet by default). The '?' is a +# conditional assignment operator: it only sets V +# if it hasn't been set externally. +V ?= 0 +ifeq ($(V),0) + AT = @ +else + AT = +endif +# Detect if we are running inside GitHub Actions CI. +# GitHub sets the environment variable GITHUB_ACTIONS=true in workflows. +# We set CI=1 if running in GitHub Actions, otherwise CI=0 for local runs. +ifeq ($(GITHUB_ACTIONS),true) +CI := 1 +else +CI := 0 +endif +# Define a reusable CI-safe runner +define run_ci_safe = +( $1 || [ "$(CI)" != "1" ] ) +endef +# -------------------------------------------------- +# โš™๏ธ Build Settings +# -------------------------------------------------- +PACKAGE_NAME = "github-docs-cookiecutter" +AUTHOR = "Jared Cook" +VERSION = "0.1.1" +PUBLISHDIR ?= +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Sphinx + Jekyll) +# -------------------------------------------------- +RUBY_INSTALL := bundle install +JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_CLEAN := bundle exec jekyll clean +JEKYLL_SERVE := bundle exec jekyll serve +# -------------------------------------------------- +.PHONY: all ruby-install jekyll jekyll-serve build run clean help +# -------------------------------------------------- +# Default: +# -------------------------------------------------- +all: ruby-install build +# -------------------------------------------------- +# โ™ฆ๏ธ Ruby +# -------------------------------------------------- +ruby-install: + $(AT)$(RUBY_INSTALL) +# -------------------------------------------------- +# ๐Ÿ“š Documentation (Jekyll) +# -------------------------------------------------- +jekyll: + $(AT)echo "๐Ÿ”จ Building Jekyll site ๐Ÿ“š..." + $(AT)$(JEKYLL_BUILD) + $(AT)echo "โœ… Full documentation build complete!" + +jekyll-serve: + $(AT)echo "๐Ÿš€ Starting Jekyll development server..." + $(AT)$(JEKYLL_SERVE) + +build: jekyll +run: jekyll-serve +# -------------------------------------------------- +# ๐Ÿงน Clean artifacts +# -------------------------------------------------- +clean: + $(AT)echo "๐Ÿงน Cleaning Jekyll build artifacts..." + $(AT)$(call run_ci_safe,$(JEKYLL_CLEAN)) + $(AT)echo "โœ… Cleaned Jekyll build artifacts." +# -------------------------------------------------- +# Help +# -------------------------------------------------- +help: + $(AT)echo "๐Ÿ“ฆ $(PACKAGE_NAME) github documentation Makefile" + $(AT)echo " author: $(PACKAGE_AUTHOR)" + $(AT)echo " version: $(PACKAGE_VERSION)" + $(AT)echo "" + $(AT)echo "Usage:" + $(AT)echo " make ruby-install Installs Gemfile packages." + $(AT)echo " make build Generate Jekyll documentation" + $(AT)echo " make run Serve Jekyll site locally" + $(AT)echo " make clean Clean Jekyll build artifacts" + $(AT)echo " make all Run make (build)" + $(AT)echo "Options:" + $(AT)echo " V=1 Enable verbose output (show all commands being executed)" + $(AT)echo " make -s Run completely silently (suppress make's own output AND command echo)" diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md new file mode 100644 index 0000000..20b8bb6 --- /dev/null +++ b/docs/jekyll/README.md @@ -0,0 +1,41 @@ +# {{ site.title }} + +[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE.md) + +__Author:__ {{ site.author }} +__Version:__ {{ site.version }} + +## Overview +{{ site.description }} + +__CI/CD Check List:__ +* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg) +* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg) +* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg) +* ![security-audit]({{ site.repo_url }}/actions/workflows/security-audit.yml/badge.svg) +* ![spellcheck]({{ site.repo_url }}/actions/workflows/spellcheck.yml/badge.svg) +* ![tests]({{ site.repo_url }}/actions/workflows/tests.yml/badge.svg) +* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) + +*** + +## Getting Started +* [Get {{ cookiecutter.project_name}}] +* [Installation guides] + +## Documentation +The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }}) + +## Contributing +If you're interested in contributing to the {{ cookiecutter.project_name }} project: +* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute.md). +* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide.md). +* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index.md). + +## License +{{ cookiecutter.copyright }} + +This project is licensed under the __{{ cookiecutter.license }} License__. +See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text. + +SPDX-License-Identifier: {{ cookiecutter.license }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml new file mode 100755 index 0000000..7bf6ee5 --- /dev/null +++ b/docs/jekyll/_config.yml @@ -0,0 +1,164 @@ +# github-docs-cookiecutter Documentation +--- +title: "github-docs-cookiecutter" +author: "Jared Cook" +version: "0.1.1" +timezone: "America/Los_Angeles" +description: "Github docs cookiecutter template generation." +remote_theme: "pmarsceill/just-the-docs" +ga_tracking: "G-C7PWLWSHB9" + +repo_url: "https://github.com/jcook3701/github-docs-cookiecutter" +repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/None" +github_io_url: "https://jcook3701.github.io/github-docs-cookiecutter" +repository: "jcook3701/github-docs-cookiecutter" + +# Specifies the site's subpath for correct URL generation +baseurl: "/github-docs-cookiecutter" + +collections: + manual: + output: true + permalink: /:collection/:path + + resources: + output: true + permalink: /:collection/:path + +just_the_docs: + collections: + manual: + name: Manual + nav_fold: true + nav_exclude: false + + resources: + name: "External Links" + nav_fold: false + nav_exclude: false + +plugins: + - jekyll-remote-theme + - jekyll-redirect-from + - jekyll-seo-tag + - jekyll-github-metadata + - jekyll-include-cache + - jekyll-sitemap + +# Author Remote User Accounts +# twitter_username: "" +github_username: "jcook3701" +linkedin_usercode: "jared-cook-b3585a114" +buymeacoffee_username: "jcook3701" + +# carousel_images: +# - /assets/images/ +# - /assets/images/ +# - /assets/images/ + +# Set a path/url to a logo that will be displayed instead of the title +# logo: /assets/images/icon128.png + +# Enable or disable the site search +search_enabled: true + +# For copy button on code +enable_copy_code_button: true + +# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in +mermaid: + # Version of mermaid library + # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/ + version: "9.1.6" + # Note: Put any additional configuration, such as setting the theme, + # in _includes/mermaid_config.js. See also docs/ui-components/code. + # Note: To load mermaid from a local library, also use the `path` key + # to specify the location of the library; e.g. for (v10+): + # path: "/assets/js/mermaid.esm.min.mjs" for (- + Copyright (c) 2025-2026, Jared Cook. Distributed by an + + AGPL-3.0-or-later license. + + + +## Footer last edited timestamp +# show or hide edit time - page must have `last_modified_date` defined in the frontmatter +last_edit_timestamp: true +# uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html +last_edit_time_format: >- + %b %e %Y at %I:%M %p +## Footer "Edit this page on GitHub" link text +# show or hide edit this page link +gh_edit_link: true +gh_edit_link_text: "Edit this page on GitHub" +# the github URL for your repo +gh_edit_repository: >- + https://github.com/jcook3701/github-docs-cookiecutter +# the branch that your docs is served from +gh_edit_branch: "master" +# the source that your files originate from +gh_edit_source: docs +# "tree" or "edit" if you want the user to jump into the editor immediately +gh_edit_view_mode: "tree" + +# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define +callouts_level: quiet # or loud +callouts: + highlight: + color: yellow + important: + title: Important + color: blue + new: + title: New + color: green + note: + title: Note + color: purple + warning: + title: Warning + color: red + +kramdown: + auto_ids: true + +include: + - .well-known + +# Exclude files/folders from Jekyll processing +exclude: + - node_modules + - .DS_Store + - Gemfile + - Gemfile.lock + +# Optional SEO metadata +seo: + title: "github-docs-cookiecutter Documentation" + description: "Full code documentation for the github-docs-cookiecutter project" diff --git a/docs/jekyll/_includes/image-carousel.html b/docs/jekyll/_includes/image-carousel.html new file mode 100644 index 0000000..f74f777 --- /dev/null +++ b/docs/jekyll/_includes/image-carousel.html @@ -0,0 +1,64 @@ +
+ +
+ {% assign slides = site.carousel_images %} {% for image in slides %} {% if + image.src %} + {{ image.caption }} + {% else %} + + {% endif %} {% endfor %} +
+ +
+ + + + diff --git a/docs/jekyll/_includes/snippet_loader.html b/docs/jekyll/_includes/snippet_loader.html new file mode 100644 index 0000000..6765a0a --- /dev/null +++ b/docs/jekyll/_includes/snippet_loader.html @@ -0,0 +1,4 @@ + diff --git a/docs/jekyll/_includes/social-bar.html b/docs/jekyll/_includes/social-bar.html new file mode 100644 index 0000000..9dd1a65 --- /dev/null +++ b/docs/jekyll/_includes/social-bar.html @@ -0,0 +1,167 @@ + +
+
    + {% if site.twitter_username %} +
  • + +
    • + {% endif %} + + {% if site.linkedin_usercode %} +
  • + + + +
    • + {% endif %} + + {% if site.github_username %} +
  • + + + +
    • + {% endif %} + + + {% if site.buymeacoffee_username %} +
  • + + + +
    • + {% endif %} +
+
+ + diff --git a/docs/jekyll/_manual/contribute/create-feature-request.md b/docs/jekyll/_manual/contribute/create-feature-request.md new file mode 100644 index 0000000..11f0226 --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-feature-request.md @@ -0,0 +1,59 @@ +--- +layout: default +title: Create a feature request +nav_order: 1 +parent: Contribute +--- +## Create a feature request + +Feature requests help us understand what you need from github-docs-cookiecutter. This document guides you through writing effective feature requests that help maintainers understand your needs and prioritize improvements. + +## Before you begin + +We're excited to hear your ideas! Before you submit a feature request, consider these resources: + +- Read the [Code of Conduct]({{ site.repo_blob }}/.github/CODE_OF_CONDUCT.md) to understand our community guidelines. +- Search [existing feature requests](https://github.com/jcook3701/github-docs-cookiecutter/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Ffeature-request) to see if someone already suggested something similar. + +## Your first feature request + +When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why. + + + +## Best practices for feature requests + +Follow these guidelines to increase the chances of your feature request being accepted: + +### Keep it focused + +Request one feature at a time. If you have multiple ideas, create separate feature requests for each one. This makes it easier to discuss, prioritize, and implement each feature independently. + +### Research first + +Before submitting, search for similar requests. If you find an existing request that's close to your idea, add your use case and context to that discussion instead of creating a duplicate. + +### Provide context + +The more context you provide, the better maintainers can understand your needs. Include: + +- Your environment or setup (which data sources, plugins, or features you're using) +- Your workflow or process +- Why this matters to you +- Any workarounds you've tried + +### Be open to alternatives + +Maintainers might suggest different approaches to solve your problem. Be open to these alternatives as they might be easier to implement or more maintainable in the long term. + +### Stay engaged + +After submitting your feature request, monitor the discussion. Answer questions from maintainers and provide clarification when needed. This helps move your request forward. + +## Contributing the feature yourself + +If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link _manual/contribute/create-pull-request.md %}). + +We welcome community contributions and appreciate your help making github-docs-cookiecutter better! diff --git a/docs/jekyll/_manual/contribute/create-pull-request.md b/docs/jekyll/_manual/contribute/create-pull-request.md new file mode 100644 index 0000000..11a9b6c --- /dev/null +++ b/docs/jekyll/_manual/contribute/create-pull-request.md @@ -0,0 +1,18 @@ +--- +layout: default +title: Create a pull request +nav_order: 1 +parent: Contribute +--- + +## Create a pull request + +Every contribution to github-docs-cookiecutter's software begins with a [pull request](https://help.github.com/en/articles/about-pull-requests/). This document guides you through the process of creating a PR. + +## Before you begin + +We know you're excited to create your first pull request. Before we get started, read these resources first: + +- Get started [contributing to github-docs-cookiecutter]({{ site.repo_url }}/CONTRIBUTING.md). +- Make sure your code follows the relevant [style guides]({% link _manual/contribute/style-guides/index.md %}). +- It's recommended you [set up precommit hooks]({% link _manual/contribute/developer-guide.md %}) to auto-format when you commit. diff --git a/docs/jekyll/_manual/contribute/developer-guide.md b/docs/jekyll/_manual/contribute/developer-guide.md new file mode 100644 index 0000000..b2b7b86 --- /dev/null +++ b/docs/jekyll/_manual/contribute/developer-guide.md @@ -0,0 +1,82 @@ +--- +layout: default +title: Developer Guide +nav_order: 1 +parent: Contribute +--- + +## Developer guide + +This guide helps you get started developing github-docs-cookiecutter. + +## Development Strategy + +All Makefile commands are used in __ci/cd__ to ensure that if they pass locally they should also pass once pushed to github. + +### ๐Ÿ๏ธ Build environment (.venv) + +``` shell +$ make install +``` + +### ๐Ÿงฌ Dependency Management (deptry) + +```shell +$ make dependency-check +``` + +### ๐Ÿ›ก๏ธ Security Audit (pip-audit) + +```shell +$ make security +``` + +### ๐ŸŽจ Formatting (black) + +```shell +$ make format-check +``` + +```shell +$ make format-fix +``` + +### ๐Ÿ” Linting (djlint, ruff, tomllint, & yaml-lint) + +``` shell +$ make lint-check +``` + +``` shell +$ make lint-fix +``` + +### ๐ŸŽ“ Spellchecking (codespell) + +```shell +$ make spellcheck +``` + +### ๐Ÿง  Typechecking (mypy) + +``` shell +$ make typecheck +``` + +### ๐Ÿงช Testing (pytest) + +``` shell +$ make test +``` + +### ๐Ÿš€ Release (git tag) + +```shell +$ make release +``` + +### โ“ Build Help + +``` shell +$ make help +``` diff --git a/docs/jekyll/_manual/contribute/git-commit-message.md b/docs/jekyll/_manual/contribute/git-commit-message.md new file mode 100644 index 0000000..07ad904 --- /dev/null +++ b/docs/jekyll/_manual/contribute/git-commit-message.md @@ -0,0 +1,25 @@ +--- +layout: default +title: "Git Commit Message" +nav_order: 1 +parent: Contribute +--- +## Git Commit Message Format Guide + +Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by pre-commit. + +__example:__ + +```shell +[optional scope]: + +[optional body] + +[optional footer(s)] +``` + +* ``````: A required noun that describes the nature of the change. +* ```[optional scope]```: An optional phrase within parentheses that specifies the part of the codebase being affected (e.g., fix(parser):). +* ``````: A required short, imperative-mood summary of the changes. +* ```[optional body]```: A longer description providing additional context and "what and why" details. +* ```[optional footer(s)]```: Used for adding meta-information, such as issue references (Fixes #123) or indicating breaking changes. diff --git a/docs/jekyll/_manual/contribute/index.md b/docs/jekyll/_manual/contribute/index.md new file mode 100644 index 0000000..8105a9d --- /dev/null +++ b/docs/jekyll/_manual/contribute/index.md @@ -0,0 +1,21 @@ +--- +layout: default +title: Contribute +nav_order: 1 +has_children: true +--- +## Contribute to the github-docs-cookiecutter project + +We're excited that you're considering making a contribution to the github-docs-cookiecutter project! This is the place to find guides for contributors to our open-source project. + +These are some good resources to explore for developers: + +* [Create a pull request]({% link _manual/contribute/create-pull-request.md %}) +* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +* [Developer guide]({% link _manual/contribute/developer-guide.md %}) +* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) + +Find [style guides]({% link _manual/contribute/style-guides/index.md %}) for the github-docs-cookiecutter software project: +* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. +* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. +* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. diff --git a/docs/jekyll/_manual/contribute/merge-pull-request.md b/docs/jekyll/_manual/contribute/merge-pull-request.md new file mode 100644 index 0000000..af1e1de --- /dev/null +++ b/docs/jekyll/_manual/contribute/merge-pull-request.md @@ -0,0 +1,61 @@ +--- +layout: default +title: Merge a pull request +nav_order: 1 +parent: Contribute +--- +## Merge a pull request + +When a pull request has been reviewed and approved by at least one person and all checks have passed, then it's time to merge the pull request. + +## Who is expected to merge a pull request? + +Maintainers are responsible for merging all pull requests. If a maintainer has opened a pull request, then the general rule is that the same maintainer merges the pull request. If a non-maintainer has opened a pull request, then it's suggested that one of the maintainers who reviews the pull request should merge the pull request. + +## Checklist of considerations + +Consider (and ask about) the items on the following checklist before merging a pull request: + +- Is it reviewed and approved? +- Have all checks passed? +- Does it have a proper pull request title? +- Does it need to be added to the changelog (release notes)? +- Does it need backporting? + +## Before merge + +Before actually merging a pull request, consider the following things: + +### Status checks + +Before you can merge a pull request, it must have a review approval, and all the required status checks must pass. + +### Format the pull request title + + + +### Changelog (automated) + +## Doing the actual merge + +The best time to actually merge the pull request varies from case to case. All commits in a pull request are squashed. + +You can change the commit message before merging. Please remember that developers might use the commit information for tasks like reviewing changes of files, doing Git blame, and resolving merge conflicts. + +While there aren't formal best practices around this process, you can consider the following guidance: + +**Do:** + +- Make sure the pull request title is formatted properly before merging. Doing so automatically gives you a good and short summary of the commit. +- Leave `Co-authored-by:` lines as is so that co-authors are credited for the contribution. +- Remove any commit information that doesn't bring any context to the change. + +**Consider:** + +- Keep any references to issues that the pull request fixes, closes, or references. Doing this allows cross-reference between the commit and referenced issue or issues. + +To finalize the merge, click the **Confirm squash and merge** button. + +## After the merge + +Make sure to close any referenced or related issues. We recommend that you assign the same milestone on the issues that the pull request fixes or closes, but this isn't required. diff --git a/docs/jekyll/_manual/contribute/style-guides/index.md b/docs/jekyll/_manual/contribute/style-guides/index.md new file mode 100644 index 0000000..c8d761a --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/index.md @@ -0,0 +1,12 @@ +--- +layout: default +title: "Style Guide" +nav_order: 1 +has_children: true +parent: Contribute +--- + +## Style Guides +* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. +* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. +* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. diff --git a/docs/jekyll/_manual/contribute/style-guides/python.md b/docs/jekyll/_manual/contribute/style-guides/python.md new file mode 100644 index 0000000..c2b3dbf --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/python.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Python Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## Python Style Guide diff --git a/docs/jekyll/_manual/contribute/style-guides/typescript.md b/docs/jekyll/_manual/contribute/style-guides/typescript.md new file mode 100644 index 0000000..df8c660 --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/typescript.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Typescript Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## Typescript Style Guide diff --git a/docs/jekyll/_manual/contribute/style-guides/yaml.md b/docs/jekyll/_manual/contribute/style-guides/yaml.md new file mode 100644 index 0000000..815b81d --- /dev/null +++ b/docs/jekyll/_manual/contribute/style-guides/yaml.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "YAML Style Guide" +nav_order: 1 +parent: "Style Guide" +--- +## YAML Style Guide diff --git a/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md new file mode 100644 index 0000000..a98d984 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla-privacy-policy.md @@ -0,0 +1,20 @@ +--- +layout: default +title: CLA Privacy Policy +nav_order: 1 +parent: "Developer Resources" +--- +## github-docs-cookiecutter CLA Privacy Policy + +## Collection and storage of personal data and the nature and purpose of their use + +Most Project business is conducted publicly, and privacy of submitted information is not expected. + +Specifically, information is exchanged via public email lists and public code repositories. Public code repositories use patch submission, pull requests, discussions, and bug reports. None of these tools keep submitted information private. They are publicly accessible and archived in multiple locations around the world, by the Project and third parties. + +You should never submit personally identifiable information (PII) via any of these mechanisms. + + diff --git a/docs/jekyll/_manual/developer-resources/cla.md b/docs/jekyll/_manual/developer-resources/cla.md new file mode 100644 index 0000000..c4545f4 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/cla.md @@ -0,0 +1,26 @@ +--- +layout: default +title: Contributor License Agreement (CLA) +nav_order: 1 +parent: "Developer Resources" +--- +## github-docs-cookiecutter Contributor License Agreement ("Agreement") V1.0 + +This agreement is based on the Apache Software Foundation Individual Contributor License Agreement ("Agreement") V2.2 + +Thank you for your interest in __The github-docs-cookiecutter project by Jared Cook,__ dba Jared Cook (the "Project"). To clarify the intellectual property license granted with Contributions from any person or entity, the Project must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of the Project and its users. It does not change your rights to use your own Contributions for any other purpose. + +You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to the Project. In return, the Project shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its nonprofit status and bylaws in effect at the time of the Contribution. Except for the license granted herein to the Project and recipients of software distributed by the Project, You reserve all right, title, and interest in and to Your Contributions. + +1. __Definitions. "You"__ (or __"Your"__) shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with the Project. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to the Project for inclusion in, or documentation of, any of the products owned or managed by the Project (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Project or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." +2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to the Project and to recipients of software distributed by the Project a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed. +4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to the Project, or that your employer has executed a separate Corporate CLA with the Project. +5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. +6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. +7. Should You wish to submit work that is not Your original creation, You may submit it to the Project separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". +8. You agree to notify the Project of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. + +This is a legal contract containing Personally Identifiable Information. +Please refer to our [cla-privacy-policy]({% link _manual/developer-resources/cla-privacy-policy.md %}) for the policy +governing how this information is used and shared. diff --git a/docs/jekyll/_manual/developer-resources/contribute.md b/docs/jekyll/_manual/developer-resources/contribute.md new file mode 100644 index 0000000..771b13f --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/contribute.md @@ -0,0 +1,32 @@ +--- +layout: default +title: Contribute +nav_order: 2 +parent: "Developer Resources" +--- +## Contribute to github-docs-cookiecutter + +This page lists resources for developers who want to contribute to the github-docs-cookiecutter ecosystem. + +## Make technical contributions + +### Contribute code to github-docs-cookiecutter + +* [Developer guide]({% link _manual/contribute/developer-guide.md %}) +* [Create a pull request] walks you through preparing a clear, descriptive pull request. +* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) +* Browse all [issues](https://github.com/jcook3701/github-docs-cookiecutter/issues/new) to find a good first task. + +### Contribute without code + +* Report a bug with the [bug report template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=01-bug-report.yml) and include steps to reproduce. +* Submit a [feature request](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature-request.yml) to propose improvements. +* Report security vulnerabilities following our [security policy]({{ site.repo_blob }}/.github/SECURITY.md). + +### Best practices and style + +Our [style guides]({% link _manual/contribute/style-guides/index.md %}) outline github-docs-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! + * [Python style guide]({% link _manual/contribute/style-guides/python.md %}). + * [Typescript style guide]({% link _manual/contribute/style-guides/typescript.md %}). + * [YAML style guide]({% link _manual/contribute/style-guides/yaml.md %}). diff --git a/docs/jekyll/_manual/developer-resources/index.md b/docs/jekyll/_manual/developer-resources/index.md new file mode 100644 index 0000000..d6b2020 --- /dev/null +++ b/docs/jekyll/_manual/developer-resources/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Developer Resources" +nav_order: 1 +has_children: true +--- +## Developer resources + +This section of the documentation contains additional resources for developers and contributors. + +## Contribute to github-docs-cookiecutter + +Refer to the [Contribute to github-docs-cookiecutter]({% link _manual/developer-resources/contribute.md %}) guide to learn the various ways you can contribute to github-docs-cookiecutter. Read the [github-docs-cookiecutter Contributor License Agreement]({% link _manual/developer-resources/cla.md %}) before making any contribution. diff --git a/docs/jekyll/_manual/introduction/getting-started.md b/docs/jekyll/_manual/introduction/getting-started.md new file mode 100644 index 0000000..aee5885 --- /dev/null +++ b/docs/jekyll/_manual/introduction/getting-started.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Getting Started +nav_order: 1 +parent: Introduction +--- +## Getting started with github-docs-cookiecutter diff --git a/docs/jekyll/_manual/introduction/index.md b/docs/jekyll/_manual/introduction/index.md new file mode 100644 index 0000000..27d594b --- /dev/null +++ b/docs/jekyll/_manual/introduction/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Introduction +nav_order: 1 +has_children: true +--- +## Introduction to github-docs-cookiecutter diff --git a/docs/jekyll/_manual/setup-guide/index.md b/docs/jekyll/_manual/setup-guide/index.md new file mode 100644 index 0000000..36cdaac --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/index.md @@ -0,0 +1,9 @@ +--- +layout: default +title: "Setup Guide" +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Setup + +1. Install all [requirements]({%link link _manual/setup-guide/requirements.md %}) to effectively pull and utilize cookiecutter template repository effectively. diff --git a/docs/jekyll/_manual/setup-guide/requirements.md b/docs/jekyll/_manual/setup-guide/requirements.md new file mode 100644 index 0000000..16d8724 --- /dev/null +++ b/docs/jekyll/_manual/setup-guide/requirements.md @@ -0,0 +1,30 @@ +--- +layout: default +title: Requirements +nav_order: 1 +parent: "Setup Guide" +--- + +## github-docs-cookiecutter Requirements + +1. Python 3.11 + ```shell + $ sudo apt install python3.11 + ``` +2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) + __Note:__ + __Example:__ Install with the following command (Recommended that this is installed in a python virtual environment): + ```shell + $ python -m pip install nutri-matic + ``` +3. [rustup](https://rust-lang.org/tools/install/) + __Note:__ I found that it is easiest to use rustup to manage rustc and cargo but this is not required. + __Example:__ Install rustup with the following: + ```shell + $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + ``` +4. [git-cliff](https://git-cliff.org/) + __Note:__ git-cliff can generate changelog files from the Git history by utilizing conventional commits as well as regex-powered custom parsers. + ```shell + $ cargo install git-cliff + ``` diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md new file mode 100644 index 0000000..df710b0 --- /dev/null +++ b/docs/jekyll/_manual/troubleshooting/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Troubleshooting +nav_order: 1 +has_children: true +--- +## Troubleshooting github-docs-cookiecutter diff --git a/docs/jekyll/_manual/tutorials/index.md b/docs/jekyll/_manual/tutorials/index.md new file mode 100644 index 0000000..937baa9 --- /dev/null +++ b/docs/jekyll/_manual/tutorials/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: Tutorials +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Tutorials diff --git a/docs/jekyll/_manual/upgrade-guide/index.md b/docs/jekyll/_manual/upgrade-guide/index.md new file mode 100644 index 0000000..afbc7a7 --- /dev/null +++ b/docs/jekyll/_manual/upgrade-guide/index.md @@ -0,0 +1,13 @@ +--- +layout: default +title: "Upgrade Guide" +nav_order: 1 +has_children: true +--- +## github-docs-cookiecutter Upgrade Guide + +### ๐Ÿช Project Updater (cookiecutter_project_upgrader) + +```shell +$ source .venv/bin/activate && cookiecutter_project_upgrader --context-file ./docs/cookiecutter_input.json --upgrade-branch main +``` diff --git a/docs/jekyll/_manual/whatsnew/index.md b/docs/jekyll/_manual/whatsnew/index.md new file mode 100644 index 0000000..9ea9be5 --- /dev/null +++ b/docs/jekyll/_manual/whatsnew/index.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "What's New" +nav_order: 1 +has_children: true +--- +## What's new in github-docs-cookiecutter diff --git a/docs/jekyll/_resources/repository-link.md b/docs/jekyll/_resources/repository-link.md new file mode 100644 index 0000000..98d326c --- /dev/null +++ b/docs/jekyll/_resources/repository-link.md @@ -0,0 +1,5 @@ +--- +title: "github-docs-cookiecutter on GitHub ๐Ÿ”—" +nav_order: 1 +redirect_to: "https://github.com/jcook3701/github-docs-cookiecutter" +--- diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json new file mode 100644 index 0000000..749a6a3 --- /dev/null +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -0,0 +1,44 @@ +{ + "__year_range": "2025-2026", + "_checkout": null, + "_copy_without_render": [ + "README.md", + "_includes/*" + ], + "_extensions": [ + "jinja2.ext.do", + "jinja2.ext.loopcontrols", + "jinja2_time.TimeExtension" + ], + "_is_sub_template": true, + "_jinja2_env_vars": { + "lstrip_blocks": true, + "trim_blocks": true + }, + "_output_dir": "/home/jcook/Documents/git_repo/github-doc-cookiecutter/.git/cookiecutter/github-docs-cookiecutter/docs/_tmp_docs", + "_repo_dir": "/home/jcook/.cookiecutters/github-docs-cookiecutter", + "_template": "https://github.com/jcook3701/github-docs-cookiecutter.git", + "author": "Jared Cook", + "buymeacoffee_username": "jcook3701", + "company": null, + "contribution_model": "CLA", + "copyright": "Copyright (c) 2025-2026, Jared Cook", + "current_year": "2026", + "description": "Github docs cookiecutter template generation.", + "email": "jcook3701+github@gmail.com", + "ga_tracking": "G-C7PWLWSHB9", + "github_io": "https://jcook3701.github.io/github-docs-cookiecutter", + "github_org": null, + "github_username": "jcook3701", + "license": "AGPL-3.0-or-later", + "linkedin_usercode": "jared-cook-b3585a114", + "project_name": "github-docs-cookiecutter", + "project_slug": "github-docs-cookiecutter", + "publication_year": "2025", + "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", + "template_type": "cookiecutter", + "theme": "pmarsceill/just-the-docs", + "timezone": "America/Los_Angeles", + "twitter_username": "", + "version": "0.1.1" +} diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md new file mode 100644 index 0000000..d675500 --- /dev/null +++ b/docs/jekyll/index.md @@ -0,0 +1,24 @@ +--- +layout: default +title: github-docs-cookiecutter +nav_order: 1 +description: Github docs cookiecutter template generation. +--- + + + +{% include snippet_loader.html %} + +{% if site.carousel_images %} + {% include image-carousel.html %} +{% endif %} + +{% include_relative README.md %} + +## โ˜• Support Me +If you enjoy this project, please consider buying me a coffee or making a code contribution. + +## Social Links + +{% include social-bar.html %} + diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py index 6bf4700..1518627 100644 --- a/hooks/post_gen_project.py +++ b/hooks/post_gen_project.py @@ -21,6 +21,7 @@ from nutrimatic.core import make from nutrimatic.hooks.post_gen_logic import ( + generate_cliff_changelog_dirs, generate_docs_templates, get_make_cmds, ) @@ -37,6 +38,7 @@ def main() -> None: # Access cookiecutter context safely context = json.loads("""{{ cookiecutter | jsonify }}""") generate_docs_templates(context) + generate_cliff_changelog_dirs() # Run make commands to get project seeded make_cmds: list[str] = get_make_cmds(context) From a5893fb4c140ae3dbe25005076ac883007bd8861 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Tue, 27 Jan 2026 00:37:56 -0800 Subject: [PATCH 06/11] Update template --- .github/workflows/cla.yml | 4 ++-- docs/cookiecutter_input.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index cfd292a..fcdd086 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -48,9 +48,9 @@ jobs: with: signed-commit-message: 'chore: $contributorName has signed the CLA' path-to-signatures: 'signatures/version1/cla.json' - path-to-document: 'https://github.com/${{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document + path-to-document: 'https://github.com/${{ github.repository }}/blob/main/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document # branch should not be protected - branch: "master" + branch: "main" allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index baa0ac4..67fb752 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -15,7 +15,7 @@ "__year_range": "2025-2026", "_checkout": "main", "_copy_without_render": [], - "_default_branch": "master", + "_default_branch": "main", "_extensions": [ "jinja2.ext.do", "jinja2.ext.loopcontrols" From 638e3a89e56f8c4ff495af39b46eb3cef98b739d Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Tue, 27 Jan 2026 00:45:58 -0800 Subject: [PATCH 07/11] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/_config.yml | 2 +- docs/jekyll/docs/cookiecutter_input.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 67fb752..1293f81 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -59,7 +59,7 @@ "python_version": "3.11", "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", "template_type": "cookiecutter", - "theme": "pmarsceill/just-the-docs", + "theme": "just-the-docs/just-the-docs@v0.11.0", "timezone": "America/Los_Angeles", "twitter_username": "", "version": "0.1.1" diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml index 7bf6ee5..8ea5c0f 100755 --- a/docs/jekyll/_config.yml +++ b/docs/jekyll/_config.yml @@ -5,7 +5,7 @@ author: "Jared Cook" version: "0.1.1" timezone: "America/Los_Angeles" description: "Github docs cookiecutter template generation." -remote_theme: "pmarsceill/just-the-docs" +remote_theme: "just-the-docs/just-the-docs@v0.11.0" ga_tracking: "G-C7PWLWSHB9" repo_url: "https://github.com/jcook3701/github-docs-cookiecutter" diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json index 749a6a3..4b3d29a 100644 --- a/docs/jekyll/docs/cookiecutter_input.json +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -37,7 +37,7 @@ "publication_year": "2025", "repo_url": "https://github.com/jcook3701/github-docs-cookiecutter", "template_type": "cookiecutter", - "theme": "pmarsceill/just-the-docs", + "theme": "just-the-docs/just-the-docs@v0.11.0", "timezone": "America/Los_Angeles", "twitter_username": "", "version": "0.1.1" From 2a84d8694e65e36fd42981b8dcc302dd7e0ce81c Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Tue, 27 Jan 2026 01:11:26 -0800 Subject: [PATCH 08/11] Update template --- docs/cookiecutter_input.json | 2 +- docs/jekyll/_config.yml | 2 +- docs/jekyll/_manual/contribute/index.md | 14 +++++++------- docs/jekyll/docs/cookiecutter_input.json | 1 + 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 1293f81..29bef7a 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -26,7 +26,7 @@ "changelog": false, "git-init": false, "pre-commit-init": false, - "python-install": false + "python-install": true } }, "_is_sub_template": false, diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml index 8ea5c0f..d3c25c4 100755 --- a/docs/jekyll/_config.yml +++ b/docs/jekyll/_config.yml @@ -9,7 +9,7 @@ remote_theme: "just-the-docs/just-the-docs@v0.11.0" ga_tracking: "G-C7PWLWSHB9" repo_url: "https://github.com/jcook3701/github-docs-cookiecutter" -repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/None" +repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/master" github_io_url: "https://jcook3701.github.io/github-docs-cookiecutter" repository: "jcook3701/github-docs-cookiecutter" diff --git a/docs/jekyll/_manual/contribute/index.md b/docs/jekyll/_manual/contribute/index.md index 8105a9d..a5160dc 100644 --- a/docs/jekyll/_manual/contribute/index.md +++ b/docs/jekyll/_manual/contribute/index.md @@ -10,12 +10,12 @@ We're excited that you're considering making a contribution to the github-docs-c These are some good resources to explore for developers: -* [Create a pull request]({% link _manual/contribute/create-pull-request.md %}) -* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) -* [Developer guide]({% link _manual/contribute/developer-guide.md %}) -* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) +* [Create a pull request]({% link _manual/contribute/create-pull-request.md %}) +* [Create a feature request]({% link _manual/contribute/create-feature-request.md %}) +* [Developer guide]({% link _manual/contribute/developer-guide.md %}) +* [Merge a pull request]({% link _manual/contribute/merge-pull-request.md %}) Find [style guides]({% link _manual/contribute/style-guides/index.md %}) for the github-docs-cookiecutter software project: -* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. -* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. -* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. +* [Python]({% link _manual/contribute/style-guides/python.md %}) style guide. +* [Typescript]({% link _manual/contribute/style-guides/typescript.md %}) style guide. +* [YAML]({% link _manual/contribute/style-guides/yaml.md %}) style guide. diff --git a/docs/jekyll/docs/cookiecutter_input.json b/docs/jekyll/docs/cookiecutter_input.json index 4b3d29a..272945c 100644 --- a/docs/jekyll/docs/cookiecutter_input.json +++ b/docs/jekyll/docs/cookiecutter_input.json @@ -5,6 +5,7 @@ "README.md", "_includes/*" ], + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", "jinja2.ext.loopcontrols", From 2d1933d76e6dc26e3cb01d4f4118ca5683e0a96a Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Tue, 27 Jan 2026 16:18:20 -0800 Subject: [PATCH 09/11] Update template --- .github/workflows/cla.yml | 4 ++-- docs/cookiecutter_input.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index fcdd086..cfd292a 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -48,9 +48,9 @@ jobs: with: signed-commit-message: 'chore: $contributorName has signed the CLA' path-to-signatures: 'signatures/version1/cla.json' - path-to-document: 'https://github.com/${{ github.repository }}/blob/main/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document + path-to-document: 'https://github.com/${{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document # branch should not be protected - branch: "main" + branch: "master" allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 29bef7a..7e4f101 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -15,7 +15,7 @@ "__year_range": "2025-2026", "_checkout": "main", "_copy_without_render": [], - "_default_branch": "main", + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", "jinja2.ext.loopcontrols" From 52bd97c30ba42985ba9b48f1cd25b603e506fcc8 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Wed, 28 Jan 2026 20:13:19 -0800 Subject: [PATCH 10/11] Update template --- .github/CODE_OF_CONDUCT.md | 102 +++++++++++++++++++++++ .github/CONTRIBUTING.md | 17 ++-- .github/FUNDING.yml | 18 +++- .github/ISSUE_TEMPLATE/01-bug-report.yml | 2 +- .github/SECURITY.md | 15 +++- .github/SUPPORT.md | 36 ++++++++ .github/workflows/cla.yml | 27 +++--- .github/workflows/jekyll-gh-pages.yml | 4 +- cspell.json | 3 + 9 files changed, 193 insertions(+), 31 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/SUPPORT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..861caad --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,102 @@ +# Community Code of Conduct + +## Our Pledge + +We pledge to make our community welcoming, safe, and equal for all. + +We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant. + + +## Encouraged Behaviors + +While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language. + +With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including: + +1. Respecting the **purpose of our community**, our activities, and our ways of gathering. +2. Engaging **kindly and honestly** with others. +3. Respecting **different viewpoints** and experiences. +4. **Taking responsibility** for our actions and contributions. +5. Gracefully giving and accepting **constructive feedback**. +6. Committing to **repairing harm** when it occurs. +7. Behaving in other ways that promote and sustain the **well-being of our community**. + + +## Restricted Behaviors + +We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct. + +1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop. +2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people. +3. **Stereotyping or discrimination.** Characterizing anyoneโ€™s personality or behavior on the basis of immutable identities or traits. +4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community. +5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission. +6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group. +7. Behaving in other ways that **threaten the well-being** of our community. + +### Other Restrictions + +1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions. +2. **Failing to credit sources.** Not properly crediting the sources of content you contribute. +3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community. +4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors. + + +## Reporting an Issue + +Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm. + +When an incident does occur, it is important to report it promptly. + +To report a possible violation, please email [jcook3701's Email](mailto:jcook3701+github@gmail.com?subject=Report:%20Community%20Code%20of%20Conduct). + +All reports will be handled with strict confidentiality. Your email should include: + +* **Date and time** of the incident. +* **A description** of what occurred. +* **Links or screenshots** to any relevant public or private messages/logs. +* **Witnesses**, if any were present. + + + +Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution. + + +## Addressing and Repairing Harm + +If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped. + +1) Warning + 1) Event: A violation involving a single incident or series of incidents. + 2) Consequence: A private, written warning from the Community Moderators. + 3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations. +2) Temporarily Limited Activities + 1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation. + 2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members. + 3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over. +3) Temporary Suspension + 1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation. + 2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions. + 3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted. +4) Permanent Ban + 1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member. + 2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior. + 3) Repair: There is no possible repair in cases of this severity. + +This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community. + + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + + +## Attribution + +This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/). This version has been modified to replace "equity" with "equal." + +Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/) + +For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozillaโ€™s code of conduct team](https://github.com/mozilla/inclusion). diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 901c61c..7f8203b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,7 +45,7 @@ An issue that is about a real bug is closed as soon as the fix is committed. ### Reporting Security Issues If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited. -Please send the related information to . +Please send the related information to [jcook3701's email](mailto:jcook3701+github-docs-cookiecutter@gmail.com?subject=Report:%20Security%20Vulnerability). ### Usage of Labels @@ -74,22 +74,17 @@ Bug report analysis support is very welcome! (e.g. pre-analysis or proposing sol You are welcome to contribute code to github-docs-cookiecutter in order to fix bugs or to implement new features. - There are three important things to know: -1. You must be aware that you need to submit [CLA](/docs/jekyll/_manual/developer-resources/cla.md) in order for your contribution to be accepted. This is common practice in all major Open Source projects. +1. You must be aware that you need to submit [CLA](https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla) in order for your contribution to be accepted. This is common practice in all major Open Source projects. 2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines. 3. **Not all proposed contributions can be accepted**. Some features may e.g. just fit a third-party add-on better. The code must fit the overall direction of github-docs-cookiecutter and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the feature you plan to implement (make it clear you intend to contribute). - - ## Contributor License Agreement (CLA) -Due to legal reasons, contributors will be asked to accept a CLA before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) -[ICLA] and [CCLA]. +Due to legal reasons, contributors will be asked to accept a [CLA](https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla) before they submit the first pull request to this project, this happens in an automated fashion during the submission process. We use a derivative of the [ASF Contributor Agreements](https://www.apache.org/licenses/contributor-agreements.html) as can be found below. + +* [ICLA](https://www.apache.org/licenses/icla.pdf) +* [CCLA](https://www.apache.org/licenses/cla-corporate.pdf). ### Contribution Content Guidelines diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index dd36db4..d11bcc1 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,4 +1,20 @@ -# These are supported funding model platforms +# FUNDING.yml for github-docs-cookiecutter +# +# SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook +# SPDX-License-Identifier: AGPL-3.0-or-later +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . --- # github: ["jcook3701"] diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml index ed1297e..2f383fe 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -1,4 +1,4 @@ -# 01-bug_report.yml for github-docs-cookiecutter +# 01-bug-report.yml for github-docs-cookiecutter # # SPDX-FileCopyrightText: Copyright (c) 2025-2026, Jared Cook # SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/.github/SECURITY.md b/.github/SECURITY.md index c2ee1c1..6d61531 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -5,9 +5,20 @@ The github-docs-cookiecutter project is built with security and data privacy in ## Reporting We are grateful for security researchers and users reporting a vulnerability to us, first. To ensure that your request is handled in a timely manner and non-disclosure of vulnerabilities can be assured, please follow the below guideline. -__Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.__ +**Please do not report security vulnerabilities directly on GitHub. GitHub Issues can be publicly seen and therefore would result in a direct disclosure.** -For reporting a vulnerability, please send an email directly to . Please address questions about data privacy, security concepts, and other media requests for Security Researchers on our team. +For reporting a vulnerability, please send an email directly to [jcook3701's email](mailto:jcook3701+security-vulnerability@gmail.com?subject=Report:%20Security%20Vulnerability). + +To help us verify and resolve issues efficiently, please ensure your security vulnerability report includes the following: + +* **Vulnerability Type** and the specific component or URL affected. +* **Detailed Steps** to Reproduce the issue, including any specific configurations needed. +* **Proof of Concept (PoC)** such as HTTP requests, scripts, or screen recordings. +* **Impact Assessment** describing what a successful exploit would allow an attacker to do. +* **Reproduction Environment** details, including the browser, OS, or software version used. +* **Suggested Mitigation** or fix, if you have identified one. + +All reports are handled with strict confidentiality. We ask that you follow responsible disclosure by giving us reasonable time to investigate and fix the issue before sharing any details publicly. ## Disclosure Handling We are committed to timely review and respond to your request. The resolution of code defects will be handled by a dedicated group of security experts and prepared in a private GitHub repository. The project will inform the public about resolved security vulnerabilities via GitHub Security Advisories. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..286f73d --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,36 @@ +# Support Guidelines + +Thank you for using the github-docs-cookiecutter project! To help us maintain it efficiently, please check these resources before opening an issue. + +## ๐Ÿ› ๏ธ Getting Help +* **Documentation:** Start by reading our [Project Wiki](https://jcook3701.github.io/github-docs-cookiecutter). +* **FAQ:** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq). +* **Community Forums:** For general questions and "how-to" help, please use [GitHub Discussions](https://github.com/jcook3701/github-docs-cookiecutter/discussions) instead of Issues. + +## ๐Ÿ› Reporting Bugs +If you have found a bug, please: +1. Search existing [Issues](https://github.com/jcook3701/github-docs-cookiecutter/issues?state=open) to see if it has already been reported. +2. Follow the [bug report template](ISSUE_TEMPLATE/01-bug-report.yml) to provide a reproducible example. + +## ๐Ÿ”’ Security Vulnerabilities +Please **do not** report security vulnerabilities via public issues. Instead, follow our [Security Policy](https://github.com/jcook3701/github-docs-cookiecutter/blob/master/.github/SECURITY.md) to report them privately. + +## โณ Response Times +This is an open-source project maintained by volunteers. We try to respond within **48-72 hours**, but please be patient as we balance this with other commitments. + +## ๐ŸŒฑ Funding and Sponsorship + +github-docs-cookiecutter is an open-source project maintained by volunteers. Your financial support helps sustain the project by covering: + +* **Infrastructure costs:** Domain names, hosting, and CI/CD services. +* **Time:** Allowing maintainers to dedicate more time to bug fixes and new features. + +If this project has helped you, please consider supporting us through one of the following methods: + +* **[Buy Me a Coffee](https://buymeacoffee.com/jcook3701):** A simple way to provide a one-time donation. + +We greatly appreciate your support! diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index cfd292a..e3a2406 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -46,20 +46,19 @@ jobs: # This token is required only if you have configured to store the signatures in a remote repository/organization # PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} with: - signed-commit-message: 'chore: $contributorName has signed the CLA' - path-to-signatures: 'signatures/version1/cla.json' - path-to-document: 'https://github.com/${{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document + path-to-signatures: "cla/v1/signatures.json" + path-to-document: "https://jcook3701.github.io/github-docs-cookiecutter/manual/developer-resources/cla" # e.g. a CLA or a DCO document # branch should not be protected - branch: "master" + branch: "master" # Should match the branch that github pages are hosted from. allowlist: "jcook3701,github-actions[bot],dependabot[bot],bot*" - # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken - #remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository) - #remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository) - #create-file-commit-message: 'For example: Creating file for storing CLA Signatures' - #signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo' - #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign' - #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA' - #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.' - #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true) - #use-dco-flag: true - If you are using DCO instead of CLA + # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken + # remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository) + # remote-repository-name: enter the remote repository name where the signatures should be stored (Default is storing the signatures in the same repository) + create-file-commit-message: "chore(CLA): Creating file for storing CLA Signatures." + signed-commit-message: "chore(CLA): $contributorName has signed the CLA." + # custom-notsigned-prcomment: "pull request comment with Introductory message to ask new contributors to sign" + # custom-pr-sign-comment: "The signature to be committed in order to sign the CLA" + # custom-allsigned-prcomment: "pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA." + # lock-pullrequest-aftermerge: false - if you don"t want this bot to automatically lock the pull request after merging (default - true) + use-dco-flag: False # If you are using DCO instead of CLA diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml index eeeab84..34a9fd1 100644 --- a/.github/workflows/jekyll-gh-pages.yml +++ b/.github/workflows/jekyll-gh-pages.yml @@ -57,8 +57,8 @@ jobs: - name: Setup Ruby uses: ruby/setup-ruby@v1 with: - ruby-version: '3.3' # Recommended for Jekyll 4.4 in 2026 - bundler-cache: true # Runs 'bundle install' and caches gems automatically + ruby-version: "3.3" # Recommended for Jekyll 4.4 in 2026 + bundler-cache: true # Runs "bundle install" and caches gems automatically working-directory: ./docs/jekyll - name: Setup Pages uses: actions/configure-pages@v5 diff --git a/cspell.json b/cspell.json index 10dd128..c8994f3 100644 --- a/cspell.json +++ b/cspell.json @@ -13,6 +13,9 @@ "dco", "deptry", "ehthumbs", + "endmacro", + "endraw", + "endset", "gitcliff", "githubusercontent", "icla", From 6b8cb245eb1dbcf397603a41be361d854e356bc3 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Wed, 28 Jan 2026 20:45:22 -0800 Subject: [PATCH 11/11] Update template --- docs/jekyll/Makefile | 2 +- docs/jekyll/README.md | 25 +++++----- docs/jekyll/_config.yml | 2 + .../contribute/create-feature-request.md | 2 +- .../_manual/contribute/create-pull-request.md | 2 +- .../_manual/contribute/git-commit-message.md | 2 +- .../_manual/developer-resources/contribute.md | 13 +++--- .../_manual/introduction/getting-started.md | 46 +++++++++++++++++++ docs/jekyll/_manual/introduction/index.md | 3 ++ .../introduction/installation-guide.md | 7 +++ docs/jekyll/_manual/setup-guide/index.md | 2 +- .../_manual/setup-guide/requirements.md | 4 +- docs/jekyll/_manual/troubleshooting/faq.md | 8 ++++ docs/jekyll/_manual/troubleshooting/index.md | 2 + .../_manual/tutorials/create-virtual-env.md | 27 +++++++++++ docs/jekyll/_manual/tutorials/index.md | 3 ++ docs/jekyll/_manual/tutorials/nutri-matic.md | 25 ++++++++++ docs/jekyll/index.md | 4 -- 18 files changed, 150 insertions(+), 29 deletions(-) create mode 100644 docs/jekyll/_manual/introduction/installation-guide.md create mode 100644 docs/jekyll/_manual/troubleshooting/faq.md create mode 100644 docs/jekyll/_manual/tutorials/create-virtual-env.md create mode 100644 docs/jekyll/_manual/tutorials/nutri-matic.md diff --git a/docs/jekyll/Makefile b/docs/jekyll/Makefile index d0f6035..dfaf2fe 100644 --- a/docs/jekyll/Makefile +++ b/docs/jekyll/Makefile @@ -42,7 +42,7 @@ PUBLISHDIR ?= # ๐Ÿ“š Documentation (Sphinx + Jekyll) # -------------------------------------------------- RUBY_INSTALL := bundle install -JEKYLL_BUILD := bundle exec jekyll build --quiet +JEKYLL_BUILD := bundle exec jekyll build --trace --verbose JEKYLL_CLEAN := bundle exec jekyll clean JEKYLL_SERVE := bundle exec jekyll serve # -------------------------------------------------- diff --git a/docs/jekyll/README.md b/docs/jekyll/README.md index 20b8bb6..90f43a6 100644 --- a/docs/jekyll/README.md +++ b/docs/jekyll/README.md @@ -1,6 +1,6 @@ # {{ site.title }} -[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE.md) +[![License](https://img.shields.io/github/license/{{ site.github_username }}{{ site.baseurl }})](LICENSE) __Author:__ {{ site.author }} __Version:__ {{ site.version }} @@ -18,24 +18,25 @@ __CI/CD Check List:__ * ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg) *** + + ## Getting Started -* [Get {{ cookiecutter.project_name}}] -* [Installation guides] +* [Installation guide]({{ site.github_io_url }}/manual/introduction/installation-guide) ## Documentation -The {{ cookiecutter.project_name }} documentation is available at [docs]({{ site.github_io_url }}) +The {{ site.title }} documentation is available at [docs]({{ site.github_io_url }}). ## Contributing -If you're interested in contributing to the {{ cookiecutter.project_name }} project: -* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute.md). -* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide.md). -* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index.md). +If you're interested in contributing to the {{ site.title }} project: +* Start by reading the [contributing guide]({{ site.github_io_url }}/developer-resources/contribute). +* Learn how to setup your local environment, in our [developer guide]({{ site.github_io_url }}/contribute/developer-guide). +* Look through our [style guide]({{ site.github_io_url }}/contribute/style-guides/index). ## License -{{ cookiecutter.copyright }} +{{ site.copyright }} -This project is licensed under the __{{ cookiecutter.license }} License__. -See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text. +This project is licensed under the __{{ site.license }} License__. +See the [LICENSE]({{ site.repo_blob }}/LICENSE.md) file for the full license text. -SPDX-License-Identifier: {{ cookiecutter.license }} +SPDX-License-Identifier: {{ site.license }} diff --git a/docs/jekyll/_config.yml b/docs/jekyll/_config.yml index d3c25c4..67e6a20 100755 --- a/docs/jekyll/_config.yml +++ b/docs/jekyll/_config.yml @@ -3,6 +3,8 @@ title: "github-docs-cookiecutter" author: "Jared Cook" version: "0.1.1" +license: "AGPL-3.0-or-later" +copyright: "Copyright (c) 2025-2026, Jared Cook" timezone: "America/Los_Angeles" description: "Github docs cookiecutter template generation." remote_theme: "just-the-docs/just-the-docs@v0.11.0" diff --git a/docs/jekyll/_manual/contribute/create-feature-request.md b/docs/jekyll/_manual/contribute/create-feature-request.md index 11f0226..02b0a98 100644 --- a/docs/jekyll/_manual/contribute/create-feature-request.md +++ b/docs/jekyll/_manual/contribute/create-feature-request.md @@ -17,7 +17,7 @@ We're excited to hear your ideas! Before you submit a feature request, consider ## Your first feature request -When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why. +When you're ready to submit a feature request, use the [feature request template](https://github.com/jcook3701/github-docs-cookiecutter/issues/new?template=02-feature-request.yml). The template has three sections that help maintainers understand what you need and why. +* Browse all [issues](https://github.com/jcook3701/github-docs-cookiecutter/issues) to find a good first task. ### Contribute without code @@ -26,7 +26,8 @@ This page lists resources for developers who want to contribute to the github-do ### Best practices and style -Our [style guides]({% link _manual/contribute/style-guides/index.md %}) outline github-docs-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! - * [Python style guide]({% link _manual/contribute/style-guides/python.md %}). - * [Typescript style guide]({% link _manual/contribute/style-guides/typescript.md %}). - * [YAML style guide]({% link _manual/contribute/style-guides/yaml.md %}). +Our [style guides]({% link _manual/contribute/style-guides/index.md %}) outline github-docs-cookiecutter style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding! + +* [Python style guide]({% link _manual/contribute/style-guides/python.md %}). +* [Typescript style guide]({% link _manual/contribute/style-guides/typescript.md %}). +* [YAML style guide]({% link _manual/contribute/style-guides/yaml.md %}). diff --git a/docs/jekyll/_manual/introduction/getting-started.md b/docs/jekyll/_manual/introduction/getting-started.md index aee5885..d71a444 100644 --- a/docs/jekyll/_manual/introduction/getting-started.md +++ b/docs/jekyll/_manual/introduction/getting-started.md @@ -5,3 +5,49 @@ nav_order: 1 parent: Introduction --- ## Getting started with github-docs-cookiecutter + +1. [Requirements]({% link _manual/setup-guide/requirements.md %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs). + * Python3 Packages + 1. [cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github. + 2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) is required to be sourced in python environment for template cookiecutter hooks to work. + +I find that it easiest to clone the nutri-matic repository. Use the included makefile to install all python dependencies with ```make python-install``` from within the cloned directory. Then, source the created file, ```.venv/bin/activate```, or point the below script variable, ```PYTHON_VENV```, to desired python virtual environment. + +### Examples + + Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects. + +__Template Options:__ +* [cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) to generate new cookiecutter template projects. +* [python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter) to generate python3 projects. +* [ansible-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) to generate ansible galaxy project. + + + + + + + + + +```shell +#!/bin/bash + +PYTHON_VENV="~/Documents/git_repo/nutri-matic/.venv/bin/activate" + +PROJECT_NAME="example project name" +TEMPLATE="cookiecutter-cookiecutter" +LICENSE="AGPL-3.0-or-later" +BRANCH="main" +DESCRIPTION="Example cookiecutter template project." + +rm -rf $PROJECT_NAME/ +source $PYTHON_VENV +cookiecutter git@github.com:jcook3701/$TEMPLATE.git \ + --checkout $BRANCH \ + --no-input \ + project_name=$PROJECT_NAME \ + description=$DESCRIPTION \ + license=$LICENSE +deactivate +``` diff --git a/docs/jekyll/_manual/introduction/index.md b/docs/jekyll/_manual/introduction/index.md index 27d594b..0ce0f27 100644 --- a/docs/jekyll/_manual/introduction/index.md +++ b/docs/jekyll/_manual/introduction/index.md @@ -5,3 +5,6 @@ nav_order: 1 has_children: true --- ## Introduction to github-docs-cookiecutter + + +* [Getting Started]({% link _manual/introduction/getting-started.md %}) diff --git a/docs/jekyll/_manual/introduction/installation-guide.md b/docs/jekyll/_manual/introduction/installation-guide.md new file mode 100644 index 0000000..20991e6 --- /dev/null +++ b/docs/jekyll/_manual/introduction/installation-guide.md @@ -0,0 +1,7 @@ +--- +layout: default +title: "Installation Guide" +nav_order: 1 +parent: Introduction +--- +## Installation Guide for github-docs-cookiecutter (Linux) diff --git a/docs/jekyll/_manual/setup-guide/index.md b/docs/jekyll/_manual/setup-guide/index.md index 36cdaac..427075e 100644 --- a/docs/jekyll/_manual/setup-guide/index.md +++ b/docs/jekyll/_manual/setup-guide/index.md @@ -6,4 +6,4 @@ has_children: true --- ## github-docs-cookiecutter Setup -1. Install all [requirements]({%link link _manual/setup-guide/requirements.md %}) to effectively pull and utilize cookiecutter template repository effectively. +1. Install all [requirements]({% link _manual/setup-guide/requirements.md %}) to effectively pull and utilize cookiecutter template repository effectively. diff --git a/docs/jekyll/_manual/setup-guide/requirements.md b/docs/jekyll/_manual/setup-guide/requirements.md index 16d8724..6194b25 100644 --- a/docs/jekyll/_manual/setup-guide/requirements.md +++ b/docs/jekyll/_manual/setup-guide/requirements.md @@ -9,11 +9,11 @@ parent: "Setup Guide" 1. Python 3.11 ```shell - $ sudo apt install python3.11 + $ sudo apt install python3.11 python3.11-dev python3.11-venv ``` 2. [Nutri-Matic](https://github.com/jcook3701/nutri-matic) __Note:__ - __Example:__ Install with the following command (Recommended that this is installed in a python virtual environment): + __Example:__ Install with the following command (Recommended that this is installed in a python [virtual environment]({% link _manual/tutorials/create-virtual-env.md %})): ```shell $ python -m pip install nutri-matic ``` diff --git a/docs/jekyll/_manual/troubleshooting/faq.md b/docs/jekyll/_manual/troubleshooting/faq.md new file mode 100644 index 0000000..ab86dde --- /dev/null +++ b/docs/jekyll/_manual/troubleshooting/faq.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Requirements +nav_order: 1 +parent: Troubleshooting +--- + +## github-docs-cookiecutter Frequently Asked Questions diff --git a/docs/jekyll/_manual/troubleshooting/index.md b/docs/jekyll/_manual/troubleshooting/index.md index df710b0..1c4fb4d 100644 --- a/docs/jekyll/_manual/troubleshooting/index.md +++ b/docs/jekyll/_manual/troubleshooting/index.md @@ -5,3 +5,5 @@ nav_order: 1 has_children: true --- ## Troubleshooting github-docs-cookiecutter + +* **[FAQ]({% link _manual/troubleshooting/faq.md %})** Common questions are answered in our [Frequently Asked Questions](https://jcook3701.github.io/github-docs-cookiecutter/manual/troubleshooting/faq.md). diff --git a/docs/jekyll/_manual/tutorials/create-virtual-env.md b/docs/jekyll/_manual/tutorials/create-virtual-env.md new file mode 100644 index 0000000..bb8d7fc --- /dev/null +++ b/docs/jekyll/_manual/tutorials/create-virtual-env.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Create Virtual Environment +nav_order: 1 +parent: Tutorials +--- +## Install Python3 and Python Virtual Environment + +Either install python 3.10 or 3.11. Below example is to install python 3.11, however, to install and utilize python 3.10 just replace '11' with '10' in each instance below. + +```shell +$ sudo apt install python3.11 python3.11-dev python3.11-venv +``` + +## Create Virtual Environment (Python) + +First you need to decide where you would like you virtual environment to be stored. Personally I use ```~/Documents/python3-venvs``` to store utility python environments. After creating the directory where you would like to store you python environments move into it and run the below command. + +``` shell +$ python3.11 -m venv nutri-matic-venv +``` + +Then source into that python environment. + +```shell +$ source ./nutri-matic-venv/bin/activate +``` diff --git a/docs/jekyll/_manual/tutorials/index.md b/docs/jekyll/_manual/tutorials/index.md index 937baa9..25198f2 100644 --- a/docs/jekyll/_manual/tutorials/index.md +++ b/docs/jekyll/_manual/tutorials/index.md @@ -5,3 +5,6 @@ nav_order: 1 has_children: true --- ## github-docs-cookiecutter Tutorials + +* [Create Virtual Environment]({% link _manual/tutorials/create-virtual-env.md %}) +* [Nutri-Matic]({% link _manual/tutorials/nutri-matic.md %}) diff --git a/docs/jekyll/_manual/tutorials/nutri-matic.md b/docs/jekyll/_manual/tutorials/nutri-matic.md new file mode 100644 index 0000000..4fc4bda --- /dev/null +++ b/docs/jekyll/_manual/tutorials/nutri-matic.md @@ -0,0 +1,25 @@ +--- +layout: default +title: "Nutri-Matic" +nav_order: 1 +parent: Tutorials +--- +## Nutri-Matic Setup + +First clone the [Nutri-Matic](https://github.com/jcook3701/nutri-matic) python utility. This is needed to clone all [jcook3701's](https://github.com/jcook3701), cookiecutter templates, with the ```cookiecutter``` command. + +```shell +$ git clone git@github.com:jcook3701/nutri-matic.git +``` + +Next, move into the newly cloned directory, ```cd nutri-matic``` . Then utilize the [developer guide]({% link _manual/contribute/developer-guide.md %}) process and run ```make python-install``` to create a python virtual environment stored within the, ```.venv```, folder. This ensures the latest version of nutri-matic code and is very helpful for development on any of the template repositories. + +Finally, source Nutri-Matic's created virtual environment with the directory, ```.venv```, and begin generating templates. + +```shell +$ source .venv/bin/active +``` + +The Nutri-Matic package is responsible for managing all [jcook3701's](https://github.com/jcook3701) cookiecutter template hooks and build features. + +After the environment is sourced and other project dependencies are installed; templates should be able to be generated using the commands found in our [getting started]({% link _manual/introduction/getting-started.md %}) guide. diff --git a/docs/jekyll/index.md b/docs/jekyll/index.md index d675500..852c822 100644 --- a/docs/jekyll/index.md +++ b/docs/jekyll/index.md @@ -4,9 +4,6 @@ title: github-docs-cookiecutter nav_order: 1 description: Github docs cookiecutter template generation. --- - - - {% include snippet_loader.html %} {% if site.carousel_images %} @@ -21,4 +18,3 @@ If you enjoy this project, please consider buying me a coffee or making a code c ## Social Links {% include social-bar.html %} -