Skip to content

Commit 0a5be0f

Browse files
jcook3701jcook3701
committed
Update template
1 parent 552c766 commit 0a5be0f

21 files changed

Lines changed: 233 additions & 139 deletions

‎.github/CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The labels can only be set and modified by committers.
6666

6767
### Issue Reporting Disclaimer
6868

69-
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.
69+
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.
7070

7171
Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions)
7272

@@ -117,7 +117,7 @@ These are some of the rules we try to follow:
117117
* ```Fixes #(issueNumber)```
118118
* Do NOT add a colon after "Fixes" - this prevents automatic closing.
119119
6. Create a Pull Request
120-
7. Follow the link posted by the github-docs-cookiecutter to your pull request and accept it, as described in detail above.
120+
7. Follow the link posted by the, github-docs-cookiecutter, project to your pull request and accept it, as described in detail above.
121121
8. Wait for our code review and approval, possibly enhancing your change on request
122122
* 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
123123
9. Once the change has been approved we will inform you in a comment

‎.github/SECURITY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Security Vulnerabilities
22

3-
The github-docs-cookiecutter is built with security and data privacy in mind to ensure your data is safe.
3+
The github-docs-cookiecutter project is built with security and data privacy in mind to ensure your data is safe.
44

55
## Reporting
66
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‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ jobs:
5858
- name: Build with Jekyll site in /docs/jekyll
5959
run: make build-docs
6060
env:
61+
PAGES_REPO_NWO: ${{ github.repository }}
62+
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6163
JEKYLL_ENV: production
6264
- name: Upload artifact
6365
uses: actions/upload-pages-artifact@v3

LICENSE renamed to LICENSE.md

File renamed without changes.

‎docs/jekyll/README.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
# {{ site.title }}
22

3+
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE)
4+
35
__Author:__ {{ site.author }}
46
__Version:__ {{ site.version }}
57

68
## Overview
79
{{ site.description }}
810

9-
***
10-
11-
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }})](LICENSE)
12-
13-
![dependency-check](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/dependency-check.yml/badge.svg)
14-
![format-check](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/format-check.yml/badge.svg)
15-
![lint-check](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/lint-check.yml/badge.svg)
16-
![security-audit](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/security-audit.yml/badge.svg)
17-
![spellcheck](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/spellcheck.yml/badge.svg)
18-
![tests](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/tests.yml/badge.svg)
19-
![typecheck](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/actions/workflows/typecheck.yml/badge.svg)
11+
__CI/CD Check List:__
12+
* ![dependency-check]({{ site.repo_url }}/actions/workflows/dependency-check.yml/badge.svg)
13+
* ![format-check]({{ site.repo_url }}/actions/workflows/format-check.yml/badge.svg)
14+
* ![lint-check]({{ site.repo_url }}/actions/workflows/lint-check.yml/badge.svg)
15+
* ![security-audit]({{ site.repo_url }}/actions/workflows/security-audit.yml/badge.svg)
16+
* ![spellcheck]({{ site.repo_url }}/actions/workflows/spellcheck.yml/badge.svg)
17+
* ![tests]({{ site.repo_url }}/actions/workflows/tests.yml/badge.svg)
18+
* ![typecheck]({{ site.repo_url }}/actions/workflows/typecheck.yml/badge.svg)
2019

2120
***
2221

@@ -25,3 +24,11 @@ __Version:__ {{ site.version }}
2524
## Advance Examples
2625

2726
## Development Strategy
27+
28+
## License
29+
{{ cookiecutter.copyright }}
30+
31+
This project is licensed under the __{{ cookiecutter.license }} License__.
32+
See the [LICENSE](LICENSE) file for the full license text.
33+
34+
SPDX-License-Identifier: {{ cookiecutter.license }}

‎docs/jekyll/_config.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# github-docs-cookiecutter Documentation
22
---
3-
43
title: "github-docs-cookiecutter"
54
author: "Jared Cook"
65
version: "0.1.1"
@@ -9,9 +8,10 @@ description: "Github docs cookiecutter template generation."
98
remote_theme: "pmarsceill/just-the-docs"
109
ga_tracking: "G-C7PWLWSHB9"
1110

12-
repo_name: "github-docs-cookiecutter"
13-
repo_url: >
14-
https://github.com/jcook3701/github-docs-cookiecutter
11+
repo_url: "https://github.com/jcook3701/github-docs-cookiecutter"
12+
repo_blob: "https://github.com/jcook3701/github-docs-cookiecutter/blob/None/"
13+
14+
repository: "jcook3701/github-docs-cookiecutter"
1515

1616
# Specifies the site's subpath for correct URL generation
1717
baseurl: "/github-docs-cookiecutter"
@@ -101,9 +101,9 @@ back_to_top: true
101101
back_to_top_text: "Back to top"
102102

103103
footer_content: >-
104-
Copyright © 2025 Jared Cook. Distributed by an
104+
Copyright (c) 2025-2026, Jared Cook. Distributed by an
105105
<a href="https://github.com/jcook3701/github-docs-cookiecutter/blob/master/LICENSE">
106-
MIT license.
106+
AGPL-3.0-or-later license.
107107
</a>
108108
<a href=""></a>
109109

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ We're excited to hear your ideas! Before you submit a feature request, consider
1919

2020
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.
2121

22-
<!-- 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. -->
22+
<!-- TODO: Put together an example feature request.
23+
24+
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. -->
2325

2426
## Best practices for feature requests
2527

@@ -52,6 +54,6 @@ After submitting your feature request, monitor the discussion. Answer questions
5254

5355
## Contributing the feature yourself
5456

55-
If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines](create-pull-request.md).
57+
If you want to implement the feature yourself, feel free to create a pull request following the [pull request guidelines]({% link create-pull-request.md %}).
5658

5759
We welcome community contributions and appreciate your help making github-docs-cookiecutter better!

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Every contribution to github-docs-cookiecutter's software begins with a [pull re
1313

1414
We know you're excited to create your first pull request. Before we get started, read these resources first:
1515

16-
- Get started [contributing to github-docs-cookiecutter](/CONTRIBUTING.md).
17-
- Make sure your code follows the relevant [style guides](style-guides).
18-
- It's recommended you [set up precommit hooks](developer-guide.md) to auto-format when you commit
16+
- Get started [contributing to github-docs-cookiecutter]({{ site.repo_url }}/CONTRIBUTING.md).
17+
- Make sure your code follows the relevant [style guides]({% link style-guides/index.md %}).
18+
- It's recommended you [set up precommit hooks]({% link developer-guide.md %}) to auto-format when you commit.

‎docs/jekyll/_manual/contribute/developer-guide.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,75 @@ parent: Contribute
88
## Developer guide
99

1010
This guide helps you get started developing github-docs-cookiecutter.
11+
12+
## Development Strategy
13+
14+
All Makefile commands are used in __ci/cd__ to ensure that if they pass locally they should also pass once pushed to github.
15+
16+
### 🐍️ Build environment (.venv)
17+
18+
``` shell
19+
$ make install
20+
```
21+
22+
### 🧬 Dependency Management (deptry)
23+
24+
```shell
25+
$ make dependency-check
26+
```
27+
28+
### 🛡️ Security Audit (pip-audit)
29+
30+
```shell
31+
$ make security
32+
```
33+
34+
### 🎨 Formatting (black)
35+
36+
```shell
37+
$ make format-check
38+
```
39+
40+
```shell
41+
$ make format-fix
42+
```
43+
44+
### 🔍 Linting (jinja2-cli, ruff, tomllint, & yaml-lint)
45+
46+
``` shell
47+
$ make lint-check
48+
```
49+
50+
``` shell
51+
$ make lint-fix
52+
```
53+
54+
### 🎓 Spellchecking (codespell)
55+
56+
```shell
57+
$ make spellcheck
58+
```
59+
60+
### 🧠 Typechecking (mypy)
61+
62+
``` shell
63+
$ make typecheck
64+
```
65+
66+
### 🧪 Testing (pytest)
67+
68+
``` shell
69+
$ make test
70+
```
71+
72+
### 🚀 Release (git tag)
73+
74+
```shell
75+
$ make release
76+
```
77+
78+
### ❓ Build Help
79+
80+
``` shell
81+
$ make help
82+
```

‎docs/jekyll/_manual/contribute/git-commit-message.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
title: "Git Commit Message"
4+
nav_order: 1
5+
parent: Contribute
6+
---
7+
## Git Commit Message Format Guide
8+
9+
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.
10+
11+
__example:__
12+
13+
```shell
14+
<type>[optional scope]: <description>
15+
16+
[optional body]
17+
18+
[optional footer(s)]
19+
```
20+
21+
* ```<type>```: A required noun that describes the nature of the change.
22+
* ```[optional scope]```: An optional phrase within parentheses that specifies the part of the codebase being affected (e.g., fix(parser):).
23+
* ```<description>```: A required short, imperative-mood summary of the changes.
24+
* ```[optional body]```: A longer description providing additional context and "what and why" details.
25+
* ```[optional footer(s)]```: Used for adding meta-information, such as issue references (Fixes #123) or indicating breaking changes.

0 commit comments

Comments
 (0)