Skip to content

Commit 141482a

Browse files
committed
feat(cla): CLA documentation and much more. Getting project contribution guidelines setup.
1 parent dd83b02 commit 141482a

30 files changed

Lines changed: 440 additions & 173 deletions

File tree

.markdownlint.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ MD007:
2828
# Many developers disable this to allow long URLs or technical prose
2929
MD013: false
3030

31+
# MD014/commands-show-output: Dollar signs used before commands without showing output
32+
# This prevents copy-paste errors by ensuring leading dollar signs are only used when
33+
# output is also present to distinguish them.
34+
MD014: false
35+
3136
# MD022/blanks-around-headings: Headings should be surrounded by blank lines
3237
# Disabling this allows headings to be immediately preceded or followed by text
3338
MD022: false
@@ -40,6 +45,9 @@ MD024:
4045
MD029:
4146
style: "ordered"
4247

48+
# MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank linesmarkdownlintMD031
49+
MD031: false
50+
4351
# MD032/blanks-around-lists: Lists should be surrounded by blank lines
4452
# Setting this to false ignores the rule entirely
4553
MD032: false

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
<h2 id="overview-1">Overview:</h2>
1515
<p>Template cookiecutter project for Github Pages (Jekyll). Skip the boring stuff and get to the work that matters.</p>
1616

17+
<hr />
18+
19+
<p><a href="LICENSE"><img src="https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter" alt="License" /></a></p>
20+
1721
<p><img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg" alt="dependency-check" />
1822
<img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/format-check.yml/badge.svg" alt="format-check" />
1923
<img src="https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/lint-check.yml/badge.svg" alt="lint-check" />

changelogs/CHANGELOG.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,18 @@ Feat (005)
3737
- Merge pull request #21 from jcook3701/develop
3838

3939
Develop
40+
- Feat 006 (#23)
4041

41-
### 🐛 Fixed
42+
* feat(docs): Preparing project for Contributor License Agreements and getting major project documentation ready.
4243

43-
- *(template)* Updates to template cookiecutter.json file.
44+
* chore(update): Update from cookiecutter-cookiecutter using cookiecutter_project_upgrader.
45+
- Merge pull request #24 from jcook3701/develop
4446

45-
### 🚀 Added
47+
Feat 006 (#23)
4648

47-
- *(docs)* Preparing project for Contributor License Agreements and getting major project documentation ready.
49+
### 🐛 Fixed
50+
51+
- *(template)* Updates to template cookiecutter.json file.
4852
## [0.1.0] - 2025-12-05
4953

5054
### ⚙️ Miscellaneous

changelogs/releases/v0.1.1.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Changelog:
33
# --------------------------------------------------
44

5-
## [0.1.1] - 2026-01-15
5+
## [0.1.1] - 2026-01-20
66

77
### ⚙️ Miscellaneous
88

@@ -37,11 +37,15 @@ Feat (005)
3737
- Merge pull request #21 from jcook3701/develop
3838

3939
Develop
40+
- Feat 006 (#23)
4041

41-
### 🐛 Fixed
42+
* feat(docs): Preparing project for Contributor License Agreements and getting major project documentation ready.
4243

43-
- *(template)* Updates to template cookiecutter.json file.
44+
* chore(update): Update from cookiecutter-cookiecutter using cookiecutter_project_upgrader.
45+
- Merge pull request #24 from jcook3701/develop
4446

45-
### 🚀 Added
47+
Feat 006 (#23)
4648

47-
- *(docs)* Preparing project for Contributor License Agreements and getting major project documentation ready.
49+
### 🐛 Fixed
50+
51+
- *(template)* Updates to template cookiecutter.json file.

cookiecutter.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"version": "0.1.0",
77
"description": "Cookiecutter documentation for future project Github Wiki Pages.",
88
"theme": [
9+
"just-the-docs/just-the-docs@v0.11.0",
910
"pmarsceill/just-the-docs",
1011
"carlosperate/jekyll-theme-rtd"
1112
],

cspell.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"useGitignore": true,
55
"words": [
66
"bumpversion",
7+
"cla",
78
"cli",
89
"codespell",
910
"cookiecutter",
@@ -45,6 +46,7 @@
4546
"npm",
4647
"python",
4748
"python-common",
49+
"rust",
4850
"softwareTerms",
4951
"typescript"
5052
]

docs/jekyll/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ __Version:__ {{ site.version }}
99
## Overview:
1010
Template cookiecutter project for Github Pages (Jekyll). Skip the boring stuff and get to the work that matters.
1111

12+
***
13+
14+
[![License](https://img.shields.io/github/license/jcook3701/github-docs-cookiecutter)](LICENSE)
15+
1216
![dependency-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/dependency-check.yml/badge.svg)
1317
![format-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/format-check.yml/badge.svg)
1418
![lint-check](https://github.com/jcook3701/github-docs-cookiecutter/actions/workflows/lint-check.yml/badge.svg)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

{{ cookiecutter.project_slug }}/CONTRIBUTING.md

Lines changed: 0 additions & 116 deletions
This file was deleted.
Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
source 'https://rubygems.org'
22

3-
gem "faraday", "~> 2.7", ">= 2.7.11"
4-
gem "faraday-retry"
5-
gem "github-pages", group: :jekyll_plugins
3+
# Core Dependencies
4+
gem "faraday", "~> 2.14"
5+
gem "faraday-retry", "~> 2.3"
6+
gem "jekyll", "~> 4.4"
7+
gem "just-the-docs", "~> 0.11"
8+
9+
group :jekyll_plugins do
10+
gem "jekyll-seo-tag"
11+
gem "jekyll-sitemap"
12+
gem "jekyll-include-cache"
13+
gem "jekyll-github-metadata"
14+
gem "jekyll-remote-theme"
15+
gem "jekyll-redirect-from"
16+
end

0 commit comments

Comments
 (0)