Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/02-bug-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## 🐞 Bug Fix Description
<!-- Provide a clear and concise description of the bug and why the fix is necessary. -->

**Related Issue:** Fixes # <!-- Link the issue number here -->

### 🛠️ 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.
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/03-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## ✨ New Feature Description
<!-- What is the new functionality? What problem does it solve for the user? -->

**Related Issue:** Resolves # <!-- Link the feature request issue here -->

### 🚀 Proposed Changes
- [ ] Detail the new components, logic, or UI added.
- [ ] Mention any new dependencies introduced.

### 📸 Screenshots / Demos (If Applicable)
<!-- Drag and drop images or GIFs here to show UI changes. -->

### 🛠️ 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.
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 3 additions & 5 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
synchronize
]

# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings

Check warning on line 30 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

30:121 [line-length] line too long (126 > 120 characters)

Check warning on line 30 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

30:121 [line-length] line too long (126 > 120 characters)
permissions:
actions: write
contents: write # this can be 'read' if the signatures are in remote repository
Expand All @@ -39,21 +39,19 @@
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'

Check warning on line 42 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

42:121 [line-length] line too long (187 > 120 characters)

Check warning on line 42 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

42:121 [line-length] line too long (187 > 120 characters)
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
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # the below token should have repo scope and must be manually added by you in the repository's secret

Check warning on line 45 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

45:121 [line-length] line too long (162 > 120 characters)

Check warning on line 45 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

45:121 [line-length] line too long (162 > 120 characters)
# This token is required only if you have configured to store the signatures in a remote repository/organization

Check warning on line 46 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

46:121 [line-length] line too long (122 > 120 characters)

Check warning on line 46 in .github/workflows/cla.yml

View workflow job for this annotation

GitHub Actions / jinja2-lint

46:121 [line-length] line too long (122 > 120 characters)
# 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
# branch should not be protected
branch: 'master'
allowlist: "{{ cookiecutter.github_username }},github-actions[bot],dependabot[bot],bot*"
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
#remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
Expand Down
19 changes: 17 additions & 2 deletions changelogs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,27 @@ Feat 012 (#37)
- Merge pull request #40 from jcook3701/develop

Feat 012 (#39)
- Feat 013 (#41)

* fix(makefile): emoji for documentation fixed.

* fix(ci/cd): Jekyll build and deploy fix.

* fix(cla): Forgot to add '$' to github.repo in cla ci/cd.
- Merge pull request #42 from jcook3701/develop

Feat 013 (#41)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(makefile)* Emoji for documentation fixed.
- *(ci/cd)* Jekyll build and deploy fix.
- *(links)* Fix for document links.
- *(links)* More link fixes.
- *(upgrader)* Fixed upgrader file.

### 🚀 Added

- *(docs)* Added variables to jekyll configuration.
## [0.1.0] - 2025-12-05

### ⚙️ Miscellaneous
Expand Down
21 changes: 18 additions & 3 deletions changelogs/releases/v0.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Changelog:
# --------------------------------------------------

## [0.1.1] - 2026-01-26
## [0.1.1] - 2026-01-27

### ⚙️ Miscellaneous

Expand Down Expand Up @@ -120,9 +120,24 @@ Feat 012 (#37)
- Merge pull request #40 from jcook3701/develop

Feat 012 (#39)
- Feat 013 (#41)

* fix(makefile): emoji for documentation fixed.

* fix(ci/cd): Jekyll build and deploy fix.

* fix(cla): Forgot to add '$' to github.repo in cla ci/cd.
- Merge pull request #42 from jcook3701/develop

Feat 013 (#41)

### 🐛 Fixed

- *(template)* Updates to template cookiecutter.json file.
- *(makefile)* Emoji for documentation fixed.
- *(ci/cd)* Jekyll build and deploy fix.
- *(links)* Fix for document links.
- *(links)* More link fixes.
- *(upgrader)* Fixed upgrader file.

### 🚀 Added

- *(docs)* Added variables to jekyll configuration.
3 changes: 2 additions & 1 deletion docs/cookiecutter_input.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"__year_range": "2025-2026",
"_checkout": "main",
"_copy_without_render": [],
"_default_branch": "master",
"_extensions": [
"jinja2.ext.do",
"jinja2.ext.loopcontrols"
Expand All @@ -28,7 +29,7 @@
"python-install": false
}
},
"_is_sub_template": false,
"_is_sub_template": true,
"_jinja2_env_vars": {
"lstrip_blocks": true,
"trim_blocks": true
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.project_slug }}/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ga_tracking: "{{ cookiecutter.ga_tracking }}"

repo_url: "{{ cookiecutter.repo_url }}"
repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}/"

github_io_url: "https://{{ cookiecutter.github_username }}.github.io/"
repository: "{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}"

# Specifies the site's subpath for correct URL generation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Feature requests help us understand what you need from {{ cookiecutter.project_n

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.
- Read the [Code of Conduct]({% raw %}{{ site.repo_blob }}/.github/CODE_OF_CONDUCT.md{% endraw %}) to understand our community guidelines.
- Search [existing feature requests]({{ cookiecutter.repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3Atype%2Ffeature-request) to see if someone already suggested something similar.

## Your first feature request
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
layout: default
title: "YAML Style Guide"
nav_order: 1
parent: "Style Guide"
---
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ You accept and agree to the following terms and conditions for Your Contribution
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
Please refer to our [cla-privacy-policy]({% raw %}{% link _manual/developer-resources/cla-privacy-policy.md %}{% endraw %}) for the policy
governing how this information is used and shared.
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,21 @@ This page lists resources for developers who want to contribute to the {{ cookie

### Contribute code to {{ cookiecutter.project_name }}

* [Contributing to {{ cookiecutter.project_name }}]()
* [Developer guide]()
* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
* [Create a pull request] walks you through preparing a clear, descriptive pull request.
* Browse all [issues]({{ cookiecutter.repo_url }}/issues/new) to find a good first task. You can also filter by [help wanted]().
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
* Browse all [issues]({{ cookiecutter.repo_url }}/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]({{ cookiecutter.repo_url }}/issues/new?template=01-bug-report.yml) and include steps to reproduce.
* Submit a [feature request]({{ cookiecutter.repo_url }}/issues/new?template=02-feature-request.yml) to propose improvements.
* Report security vulnerabilities following our [security policy]().
* Report security vulnerabilities following our [security policy]({% raw %}{{ site.repo_blob }}/.github/SECURITY.md{% endraw %}).

### Best practices and style

Our [style guides]() outline {{ cookiecutter.project_name }} 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]().
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ This section of the documentation contains additional resources for developers a

## Contribute to {{ cookiecutter.project_name }}

Refer to the [Contribute to {{ cookiecutter.project_name }}]() guide to learn the various ways you can contribute to {{ cookiecutter.project_name }}. Read the [{{ cookiecutter.project_name }} Contributor License Agreement]() before making any contribution.
Refer to the [Contribute to {{ cookiecutter.project_name }}]({% raw %}{% link _manual/developer-resources/contribute.md %}{% endraw %}) guide to learn the various ways you can contribute to {{ cookiecutter.project_name }}. Read the [{{ cookiecutter.project_name }} Contributor License Agreement]({% raw %}{% link _manual/developer-resources/cla.md %}{% endraw %}) before making any contribution.
Loading