Merge pull request #34 from jcook3701/develop

Feat 010 (#33)

Author: jcook3701

.github/CONTRIBUTING.md

@@ -66,7 +66,7 @@ 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.
+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)
 
@@ -117,7 +117,7 @@ These are some of the rules we try to follow:
     * ```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 to your pull request and accept it, as described in detail above.
+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

.github/SECURITY.md

@@ -1,6 +1,6 @@
 # Security Vulnerabilities
 
-The github-docs-cookiecutter is built with security and data privacy in mind to ensure your data is safe.
+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.

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

@@ -58,6 +58,8 @@ jobs:
       - name: Build with Jekyll site in /docs/jekyll
         run: make build-docs
         env:
+          PAGES_REPO_NWO: ${{ github.repository }}
+          JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           JEKYLL_ENV: production
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -61,22 +61,36 @@ Feat 007 cla continued (#25)
 - Merge pull request #28 from jcook3701/develop
 
 Feat 009 jekyll ci cd (#27)
-- Merge branch 'develop' into feat-008-cla
+- Feat 008 cla (#30)
+
+* Update template
+
+* fix(docs): fix for the jekyll ci/cd.  Switched to my makefile build and am using that build path.
+
+* Update template
+
+* fix(readme): Moved commit-message help out of readme into better spot within documentation.  Also info update for contributing.
+
+* feat(cla): CLA Policy and CLA Privacy Policy setup.
+
+* fix(license): Preparation for license update.
+
+* Update template
+
+* fix(build): fixed build errors.
+- Merge pull request #32 from jcook3701/develop
+
+Feat 008 cla (#30)
+- Update template
 - Update template
 - Update template
 - Update template
-- Merge branch 'cookiecutter-template' into feat-008-cla
+- Merge branch 'cookiecutter-template' into feat-010
 
 ### 🐛 Fixed
 
 - *(template)* Updates to template cookiecutter.json file.
-- *(docs)* Fix for the jekyll ci/cd.  Switched to my makefile build and am using that build path.
-- *(readme)* Moved commit-message help out of readme into better spot within documentation.  Also info update for contributing.
-- *(license)* Preparation for license update.
-
-### 🚀 Added
-
-- *(cla)* CLA Policy and CLA Privacy Policy setup.
+- *(license)* Removed doubled copy of the license file.
 ## [0.1.0] - 2025-12-05
 
 ### ⚙️  Miscellaneous

changelogs/CHANGELOG.md

@@ -2,7 +2,7 @@
 # Changelog:
 # --------------------------------------------------
 
-## [0.1.1] - 2026-01-24
+## [0.1.1] - 2026-01-26
 
 ### ⚙️  Miscellaneous
 
@@ -61,19 +61,33 @@ Feat 007 cla continued (#25)
 - Merge pull request #28 from jcook3701/develop
 
 Feat 009 jekyll ci cd (#27)
-- Merge branch 'develop' into feat-008-cla
+- Feat 008 cla (#30)
+
+* Update template
+
+* fix(docs): fix for the jekyll ci/cd.  Switched to my makefile build and am using that build path.
+
+* Update template
+
+* fix(readme): Moved commit-message help out of readme into better spot within documentation.  Also info update for contributing.
+
+* feat(cla): CLA Policy and CLA Privacy Policy setup.
+
+* fix(license): Preparation for license update.
+
+* Update template
+
+* fix(build): fixed build errors.
+- Merge pull request #32 from jcook3701/develop
+
+Feat 008 cla (#30)
+- Update template
 - Update template
 - Update template
 - Update template
-- Merge branch 'cookiecutter-template' into feat-008-cla
+- Merge branch 'cookiecutter-template' into feat-010
 
 ### 🐛 Fixed
 
 - *(template)* Updates to template cookiecutter.json file.
-- *(docs)* Fix for the jekyll ci/cd.  Switched to my makefile build and am using that build path.
-- *(readme)* Moved commit-message help out of readme into better spot within documentation.  Also info update for contributing.
-- *(license)* Preparation for license update.
-
-### 🚀 Added
-
-- *(cla)* CLA Policy and CLA Privacy Policy setup.
+- *(license)* Removed doubled copy of the license file.

changelogs/releases/v0.1.1.md

@@ -1,6 +1,5 @@
 # github-docs-cookiecutter Documentation
 ---
-
 title: "github-docs-cookiecutter"
 author: "Jared Cook"
 version: "0.1.1"
@@ -9,9 +8,10 @@ description: "Github docs cookiecutter template generation."
 remote_theme: "pmarsceill/just-the-docs"
 ga_tracking: "G-C7PWLWSHB9"
 
-repo_name: "github-docs-cookiecutter"
-repo_url: >
-  https://github.com/jcook3701/github-docs-cookiecutter
+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"
@@ -101,9 +101,9 @@ back_to_top: true
 back_to_top_text: "Back to top"
 
 footer_content: >-
-  Copyright © 2025 Jared Cook. Distributed by an
+  Copyright (c) 2025-2026, Jared Cook. Distributed by an
   <a href="https://github.com/jcook3701/github-docs-cookiecutter/blob/master/LICENSE">
-      MIT license.
+      AGPL-3.0-or-later license.
   </a>
   <a href=""></a>
 

docs/jekyll/_config.yml

@@ -19,7 +19,9 @@ We're excited to hear your ideas! Before you submit a feature request, consider
 
 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.
 
-<!-- Here's an [example of how all three sections work together in an actual feature request](https://github.com/jcook3701/github-docs-cookiecutter) from the github-docs-cookiecutter community. We'll analyze each section based on this example feature request. -->
+<!-- TODO: Put together an example feature request.
+
+Here's an [example of how all three sections work together in an actual feature request](https://github.com/jcook3701/github-docs-cookiecutter) from the github-docs-cookiecutter community. We'll analyze each section based on this example feature request. -->
 
 ## Best practices for feature requests
 
@@ -52,6 +54,6 @@ After submitting your feature request, monitor the discussion. Answer questions
 
 ## Contributing the feature yourself
 
-If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines](create-pull-request.md).
+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!

docs/jekyll/_manual/contribute/create-feature-request.md

@@ -13,6 +13,6 @@ Every contribution to github-docs-cookiecutter's software begins with a [pull re
 
 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](/CONTRIBUTING.md).
-- Make sure your code follows the relevant [style guides](style-guides).
-- It's recommended you [set up precommit hooks](developer-guide.md) to auto-format when you commit
+- 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.

docs/jekyll/_manual/contribute/create-pull-request.md

@@ -8,3 +8,75 @@ 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
+```