Skip to content

Commit 317884a

Browse files
lwjohnst86lwjohnst86
authored
refactor: ♻️ match changes from t-squared and from root folder (#287)
# Description This is a bunch of small changes that match from t-squared and from the root (running `just sync-template-files`). Needs a quick review. ## Checklist - [x] Ran `just run-all`
1 parent bd601bd commit 317884a

10 files changed

Lines changed: 43 additions & 34 deletions

‎template/.editorconfig‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ max_line_length = 88
1515
# Have a bit shorter line length for text docs
1616
[*.{txt,md,qmd}]
1717
max_line_length = 72
18-
indent_size = 4
1918

2019
# Python always uses 4 spaces for tabs
2120
[*.py]

‎template/.github/CODEOWNERS.jinja‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1-
# All members on Developers team get added to review PRs
2-
* {{ review_team }}
1+
# Which team or person to inform for PRs that modify these files.
2+
# `*` means all files in the repository.
3+
# TODO: Add code owners.
4+
*

‎template/.github/workflows/add-to-project.yml.jinja‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
permissions:
2121
pull-requests: write
2222
with:
23-
# TODO: Fill in the board number.
23+
# TODO: Add the board number.
2424
board-number: ""
2525
app-id: {{ '${{ vars.ADD_TO_BOARD_APP_ID }}' }}
2626
secrets:

‎template/.pre-commit-config.yaml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ repos:
1515
hooks:
1616
- id: trailing-whitespace
1717
- id: end-of-file-fixer
18+
- id: mixed-line-ending
19+
args: [--fix=lf]
1820
- id: check-merge-conflict
1921
args: [--assume-in-merge]
2022

@@ -27,11 +29,11 @@ repos:
2729
# sub-packages, which confuses pre-commit when it tries to find the latest
2830
# version
2931
- repo: https://github.com/adhtruong/mirrors-typos
30-
rev: v1.43.4
32+
rev: v1.46.2
3133
hooks:
3234
- id: typos
3335

3436
- repo: https://github.com/rvben/rumdl-pre-commit
35-
rev: v0.1.18
37+
rev: v0.1.94
3638
hooks:
3739
- id: rumdl-fmt # Auto-format

‎template/LICENSE.md.jinja‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
Copyright (c) {{ copyright_year }} {{ github_repo }} authors
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a
6+
copy of this software and associated documentation files (the
7+
"Software"), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
1112

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
13+
The above copyright notice and this permission notice shall be included
14+
in all copies or substantial portions of the Software.
1415

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎template/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
NOTE: Will be overwritten after running `just build-readme`.
1+
<!-- Will be generated from README.qmd -->

‎template/_metadata.yml.jinja‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
gh:
2-
repo: {{ github_repo }}
3-
org: {{ github_user }}
2+
org: "{{ github_user }}"
3+
repo: "{{ github_repo }}"
4+
5+
# TODO: Add a short description of the package here, used in the README and landing page.
6+
tagline: ""
47

58
links:
69
github: "https://github.com/{{ github_user }}/{{ github_repo }}"
7-
# TODO: Confirm this is the correct URL
8-
site: "https://{{ github_repo }}.{{ github_user }}.org
10+
# TODO: Add the correct URL
11+
site: ""

‎template/_quarto.yml.jinja‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
project:
2-
# TODO: change to extension name if using a custom extension
2+
# TODO: Change to extension name if using a custom extension
33
type: website
44

55
website:
@@ -8,8 +8,8 @@ website:
88
{% if hosting_provider == "gh-pages" -%}
99
site-url: "https://{{ github_user }}.github.io/{{ github_repo }}/"
1010
{%- elif hosting_provider == "netlify" -%}
11-
# TODO: Set the Netlify custom domain URL
12-
site-url: "{{ homepage }}"
11+
# TODO: Add the Netlify custom domain URL
12+
site-url: ""
1313
{%- endif %}
1414
repo-url: "https://github.com/{{ github_repo_spec }}"
1515
page-navigation: true
@@ -20,7 +20,7 @@ website:
2020
logo: "_extensions/seedcase-project/seedcase-theme/logos/{{ github_repo }}/navbar.svg"
2121
logo-alt: "{{ github_repo }} logo: Main page"
2222
{%- else %}
23-
# TODO: add logo
23+
# TODO: Add logo if desired
2424
logo: ""
2525
logo-alt: "{{ github_repo }} logo: Main page"
2626
{%- endif %}

‎template/tools/get-contributors.sh‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ contributors=$(gh api \
1111
-H "Accept: application/vnd.github+json" \
1212
-H "X-GitHub-Api-Version: 2022-11-28" \
1313
/repos/$repo_spec/contributors \
14-
--template '{{range .}} [\@{{.login}}]({{.html_url}}){{"\n"}}{{end}}' | \
14+
--template '{{range .}}[\@{{.login}}]({{.html_url}}){{"\n"}}{{end}}' | \
1515
grep -v "\[bot\]" | \
16+
sort | \
1617
tr '\n' ', ' | \
17-
sed -e 's/,$/\n/'
18+
sed -e 's/,$/\n/' | \
19+
sed -e 's/,/,\n/g'
1820
)
1921

20-
echo "The following people have contributed to this project by submitting pull requests :tada:\n\n${contributors}"
22+
echo "The following people have contributed to this project by submitting pull\nrequests :tada:\n\n${contributors}"

‎template/{% if hosting_provider == "netlify" %}_publish.yml{% endif %}.jinja‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
- source: project
22
netlify:
3-
# TODO: Include correct ID and URL
3+
# TODO: Add correct ID and URL
44
- id: ""
55
url: "https://{{ github_user }}-{{ github_repo }}.netlify.app"

0 commit comments

Comments
 (0)