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
1 change: 1 addition & 0 deletions .config/panache.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
flavor = "quarto"
exclude = [".git/", ".github/", "LICENSE.md", "README.md"]
include = ["*.qmd", "*.md", "*.md.jinja", "*.qmd.jinja"]

[format]
tab-width = 2
Expand Down
3 changes: 2 additions & 1 deletion .config/rumdl.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
1 change: 0 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
1 change: 0 additions & 1 deletion template/.config/rumdl.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ exclude = [
"**/_badges.qmd",
# Links gets mangled
"**/CONTRIBUTING.md",

]

# List style: `-`
Expand Down
7 changes: 5 additions & 2 deletions template/404.qmd.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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 %}
34 changes: 18 additions & 16 deletions template/CONTRIBUTING.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -38,22 +40,22 @@ 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
```

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
Expand Down
Loading