diff --git a/.config/panache.toml b/.config/panache.toml index a385616..75b3e89 100644 --- a/.config/panache.toml +++ b/.config/panache.toml @@ -1,5 +1,6 @@ flavor = "quarto" exclude = [".git/", ".github/", "LICENSE.md", "README.md"] +include = ["*.qmd", "*.md", "*.md.jinja", "*.qmd.jinja"] [format] tab-width = 2 diff --git a/.config/rumdl.toml b/.config/rumdl.toml index 59718d0..a8618c0 100644 --- a/.config/rumdl.toml +++ b/.config/rumdl.toml @@ -11,9 +11,10 @@ exclude = [ "**/_badges.qmd", # Links gets mangled "**/CONTRIBUTING.md.jinja", - ] +include = ["*.qmd", "*.md", "*.md.jinja", "*.qmd.jinja"] + # List style: `-` [MD004] style = "dash" diff --git a/justfile b/justfile index 7f09ca7..187406d 100644 --- a/justfile +++ b/justfile @@ -37,7 +37,6 @@ update-quarto-theme: # Update files in the template from the Copier parent folder sync-template-files: cp CODE_OF_CONDUCT.md .editorconfig template/ - cp .config/rumdl.toml .config/panache.toml template/.config/ mkdir -p template/tools cp tools/get-contributors.sh template/tools/ cp .github/pull_request_template.md template/.github/ diff --git a/template/.config/rumdl.toml b/template/.config/rumdl.toml index 2ba4800..fc0a168 100644 --- a/template/.config/rumdl.toml +++ b/template/.config/rumdl.toml @@ -11,7 +11,6 @@ exclude = [ "**/_badges.qmd", # Links gets mangled "**/CONTRIBUTING.md", - ] # List style: `-` diff --git a/template/404.qmd.jinja b/template/404.qmd.jinja index 01f9164..5190007 100644 --- a/template/404.qmd.jinja +++ b/template/404.qmd.jinja @@ -7,6 +7,7 @@ title: "The page you are looking for does not exist" --- {% if for_seedcase -%} + Let's get you back to greener grounds. 👉 Go to [homepage](/index.qmd). @@ -17,6 +18,8 @@ illustration of the number 404 surrounded by trees and mountains"} ## Illustration by [Storyset](https://storyset.com/online) {.appendix} {%- else -%} -This page does not exist, go back to the [homepage](/index.qmd) or check the URL -for typos. + +This page does not exist, go back to the [homepage](/index.qmd) or +check the URL for typos. + {%- endif %} diff --git a/template/CONTRIBUTING.md.jinja b/template/CONTRIBUTING.md.jinja index 52d5b72..07b7f73 100644 --- a/template/CONTRIBUTING.md.jinja +++ b/template/CONTRIBUTING.md.jinja @@ -4,16 +4,18 @@ The easiest way to contribute is to report issues or bugs that you might find while using `{{ github_repo }}`. You can do this by creating a -[new](https://github.com/{{ github_repo_spec }}/issues/new/choose) -issue on our GitHub repository. +[new](https://github.com/{{ github_repo_spec }}/issues/new/choose) issue on our +GitHub repository. ## :pencil2: Adding or modifying content {% if for_seedcase -%} -If you would like to contribute content, please check out our -[guidebook](https://guidebook.seedcase-project.org/) for more specific details -on how we work and develop. It is a regularly evolving document, so is at -various states of completion. + +If you would like to contribute content, please check out +our [guidebook](https://guidebook.seedcase-project.org/) for more specific +details on how we work and develop. It is a regularly evolving document, so is +at various states of completion. + {%- endif %} To contribute to `{{ github_repo }}`, you first need to install @@ -23,10 +25,10 @@ manage our package, such as to run checks and test the package. Both the uv and justfile websites have a more detailed guide on using uv, but below are some simple instructions to get you started. -It's easiest to first -[install uv](https://docs.astral.sh/uv/getting-started/installation/) and then -install justfile and the other tools with uv. Once you've installed uv, install -the other tools by running: +It's easiest to first [install +uv](https://docs.astral.sh/uv/getting-started/installation/) and then install +justfile and the other tools with uv. Once you've installed uv, install the +other tools by running: ```bash uv tool install rust-just pyrefly ruff @@ -38,7 +40,7 @@ Code. We keep all our development workflows in the `justfile`, so you can explore it to see what commands are available. To see a list of commands available, run: -``` bash +```bash just ``` @@ -46,14 +48,14 @@ As you contribute, make sure your changes will pass our tests by opening a terminal so that the working directory is the root of this package's repository and running: -``` bash +```bash just run-all ``` -When committing changes, please try to follow -[Conventional Commits](https://decisions.seedcase-project.org/why-conventional-commits/) -as Git messages. Using this convention allows us to be able to automatically -create a release based on the commit message by using +When committing changes, please try to follow [Conventional +Commits](https://decisions.seedcase-project.org/why-conventional-commits/) as +Git messages. Using this convention allows us to be able to automatically create +a release based on the commit message by using [Cocogitto](https://decisions.seedcase-project.org/why-semantic-release-with-cocogitto/). If you don't use Conventional Commits when making a commit, we will revise the pull request title to follow that format, as we use squash merges when merging