diff --git a/template/.editorconfig b/template/.editorconfig index 9cecc03..b7ae41f 100644 --- a/template/.editorconfig +++ b/template/.editorconfig @@ -15,7 +15,6 @@ max_line_length = 88 # Have a bit shorter line length for text docs [*.{txt,md,qmd}] max_line_length = 72 -indent_size = 4 # Python always uses 4 spaces for tabs [*.py] diff --git a/template/.github/CODEOWNERS.jinja b/template/.github/CODEOWNERS.jinja index 9681e53..1771aa8 100644 --- a/template/.github/CODEOWNERS.jinja +++ b/template/.github/CODEOWNERS.jinja @@ -1,2 +1,4 @@ -# All members on Developers team get added to review PRs -* {{ review_team }} +# Which team or person to inform for PRs that modify these files. +# `*` means all files in the repository. +# TODO: Add code owners. +* diff --git a/template/.github/workflows/add-to-project.yml.jinja b/template/.github/workflows/add-to-project.yml.jinja index 54ec674..0b3c55d 100644 --- a/template/.github/workflows/add-to-project.yml.jinja +++ b/template/.github/workflows/add-to-project.yml.jinja @@ -20,7 +20,7 @@ jobs: permissions: pull-requests: write with: - # TODO: Fill in the board number. + # TODO: Add the board number. board-number: "" app-id: {{ '${{ vars.ADD_TO_BOARD_APP_ID }}' }} secrets: diff --git a/template/.pre-commit-config.yaml b/template/.pre-commit-config.yaml index a863a32..ef01b05 100644 --- a/template/.pre-commit-config.yaml +++ b/template/.pre-commit-config.yaml @@ -15,6 +15,8 @@ repos: hooks: - id: trailing-whitespace - id: end-of-file-fixer + - id: mixed-line-ending + args: [--fix=lf] - id: check-merge-conflict args: [--assume-in-merge] @@ -27,11 +29,11 @@ repos: # sub-packages, which confuses pre-commit when it tries to find the latest # version - repo: https://github.com/adhtruong/mirrors-typos - rev: v1.43.4 + rev: v1.46.2 hooks: - id: typos - repo: https://github.com/rvben/rumdl-pre-commit - rev: v0.1.18 + rev: v0.1.94 hooks: - id: rumdl-fmt # Auto-format diff --git a/template/LICENSE.md.jinja b/template/LICENSE.md.jinja index 898f71b..f61bceb 100644 --- a/template/LICENSE.md.jinja +++ b/template/LICENSE.md.jinja @@ -2,20 +2,21 @@ Copyright (c) {{ copyright_year }} {{ github_repo }} authors -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/template/README.md b/template/README.md index c0dc5ea..d30abff 100644 --- a/template/README.md +++ b/template/README.md @@ -1 +1 @@ -NOTE: Will be overwritten after running `just build-readme`. + diff --git a/template/_metadata.yml.jinja b/template/_metadata.yml.jinja index 9d738f9..c4d7ef0 100644 --- a/template/_metadata.yml.jinja +++ b/template/_metadata.yml.jinja @@ -1,8 +1,11 @@ gh: - repo: {{ github_repo }} - org: {{ github_user }} + org: "{{ github_user }}" + repo: "{{ github_repo }}" + +# TODO: Add a short description of the package here, used in the README and landing page. +tagline: "" links: github: "https://github.com/{{ github_user }}/{{ github_repo }}" - # TODO: Confirm this is the correct URL - site: "https://{{ github_repo }}.{{ github_user }}.org + # TODO: Add the correct URL + site: "" diff --git a/template/_quarto.yml.jinja b/template/_quarto.yml.jinja index 15601a5..df217d5 100644 --- a/template/_quarto.yml.jinja +++ b/template/_quarto.yml.jinja @@ -1,5 +1,5 @@ project: - # TODO: change to extension name if using a custom extension + # TODO: Change to extension name if using a custom extension type: website website: @@ -8,8 +8,8 @@ website: {% if hosting_provider == "gh-pages" -%} site-url: "https://{{ github_user }}.github.io/{{ github_repo }}/" {%- elif hosting_provider == "netlify" -%} - # TODO: Set the Netlify custom domain URL - site-url: "{{ homepage }}" + # TODO: Add the Netlify custom domain URL + site-url: "" {%- endif %} repo-url: "https://github.com/{{ github_repo_spec }}" page-navigation: true @@ -20,7 +20,7 @@ website: logo: "_extensions/seedcase-project/seedcase-theme/logos/{{ github_repo }}/navbar.svg" logo-alt: "{{ github_repo }} logo: Main page" {%- else %} - # TODO: add logo + # TODO: Add logo if desired logo: "" logo-alt: "{{ github_repo }} logo: Main page" {%- endif %} diff --git a/template/tools/get-contributors.sh b/template/tools/get-contributors.sh index 7918505..b7a6585 100644 --- a/template/tools/get-contributors.sh +++ b/template/tools/get-contributors.sh @@ -11,10 +11,12 @@ contributors=$(gh api \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ /repos/$repo_spec/contributors \ - --template '{{range .}} [\@{{.login}}]({{.html_url}}){{"\n"}}{{end}}' | \ + --template '{{range .}}[\@{{.login}}]({{.html_url}}){{"\n"}}{{end}}' | \ grep -v "\[bot\]" | \ + sort | \ tr '\n' ', ' | \ - sed -e 's/,$/\n/' + sed -e 's/,$/\n/' | \ + sed -e 's/,/,\n/g' ) -echo "The following people have contributed to this project by submitting pull requests :tada:\n\n${contributors}" +echo "The following people have contributed to this project by submitting pull\nrequests :tada:\n\n${contributors}" diff --git "a/template/{% if hosting_provider == \"netlify\" %}_publish.yml{% endif %}.jinja" "b/template/{% if hosting_provider == \"netlify\" %}_publish.yml{% endif %}.jinja" index 1b8bb0b..49826c8 100644 --- "a/template/{% if hosting_provider == \"netlify\" %}_publish.yml{% endif %}.jinja" +++ "b/template/{% if hosting_provider == \"netlify\" %}_publish.yml{% endif %}.jinja" @@ -1,5 +1,5 @@ - source: project netlify: - # TODO: Include correct ID and URL + # TODO: Add correct ID and URL - id: "" url: "https://{{ github_user }}-{{ github_repo }}.netlify.app"