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/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 index 9b3bc45..cfd292a 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -42,9 +42,7 @@ jobs: 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 + 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: @@ -52,8 +50,8 @@ jobs: 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) diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index 9474291..0442e95 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -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 diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index 5a49b0a..80a1be8 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -2,7 +2,7 @@ # Changelog: # -------------------------------------------------- -## [0.1.1] - 2026-01-26 +## [0.1.1] - 2026-01-27 ### โš™๏ธ Miscellaneous @@ -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. diff --git a/docs/cookiecutter_input.json b/docs/cookiecutter_input.json index 7cee12b..be6da46 100644 --- a/docs/cookiecutter_input.json +++ b/docs/cookiecutter_input.json @@ -15,6 +15,7 @@ "__year_range": "2025-2026", "_checkout": "main", "_copy_without_render": [], + "_default_branch": "master", "_extensions": [ "jinja2.ext.do", "jinja2.ext.loopcontrols" @@ -28,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/{{ cookiecutter.project_slug }}/_config.yml b/{{ cookiecutter.project_slug }}/_config.yml index c84a292..54045a5 100755 --- a/{{ cookiecutter.project_slug }}/_config.yml +++ b/{{ cookiecutter.project_slug }}/_config.yml @@ -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 diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md b/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md index e77ff68..f6b187e 100644 --- a/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md @@ -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 diff --git a/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md new file mode 100644 index 0000000..b3f4b35 --- /dev/null +++ b/{{ cookiecutter.project_slug }}/_manual/contribute/style-guides/yaml.md @@ -0,0 +1,6 @@ +--- +layout: default +title: "YAML Style Guide" +nav_order: 1 +parent: "Style Guide" +--- diff --git a/{{ cookiecutter.project_slug }}/_manual/developer-resources/cla.md b/{{ cookiecutter.project_slug }}/_manual/developer-resources/cla.md index e7f5b9b..7cf6d79 100644 --- a/{{ cookiecutter.project_slug }}/_manual/developer-resources/cla.md +++ b/{{ cookiecutter.project_slug }}/_manual/developer-resources/cla.md @@ -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. diff --git a/{{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md b/{{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md index 5e02fc2..8b0f25b 100644 --- a/{{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md +++ b/{{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md @@ -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. ### 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 %}). diff --git a/{{ cookiecutter.project_slug }}/_manual/developer-resources/index.md b/{{ cookiecutter.project_slug }}/_manual/developer-resources/index.md index 7c6174c..340164f 100644 --- a/{{ cookiecutter.project_slug }}/_manual/developer-resources/index.md +++ b/{{ cookiecutter.project_slug }}/_manual/developer-resources/index.md @@ -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.