diff --git a/.config/rumdl.toml b/.config/rumdl.toml index 1507832..59718d0 100644 --- a/.config/rumdl.toml +++ b/.config/rumdl.toml @@ -9,6 +9,9 @@ exclude = [ "**/LICENSE.md", # `_badges.qmd` gets mangled by rumdl "**/_badges.qmd", + # Links gets mangled + "**/CONTRIBUTING.md.jinja", + ] # List style: `-` diff --git a/template/.config/rumdl.toml b/template/.config/rumdl.toml index 1507832..2ba4800 100644 --- a/template/.config/rumdl.toml +++ b/template/.config/rumdl.toml @@ -9,6 +9,9 @@ exclude = [ "**/LICENSE.md", # `_badges.qmd` gets mangled by rumdl "**/_badges.qmd", + # Links gets mangled + "**/CONTRIBUTING.md", + ] # List style: `-` diff --git a/template/CONTRIBUTING.md.jinja b/template/CONTRIBUTING.md.jinja index 4f3fbed..52d5b72 100644 --- a/template/CONTRIBUTING.md.jinja +++ b/template/CONTRIBUTING.md.jinja @@ -2,8 +2,8 @@ ## :bug: Issues and bugs -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 +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. @@ -80,13 +80,13 @@ one commit. renderer. - `ruff.toml`: [Ruff](https://docs.astral.sh/ruff/) configuration file for linting and formatting Python code. - - `rumdl.toml` and `panache.toml`: [rumdl](https://rumdl.dev) and - [Panache](https://panache.bz) configuration file for formatting Markdown - files in the project. + - `rumdl.toml` and `panache.toml`: [rumdl](https://rumdl.dev) and + [Panache](https://panache.bz) configuration file for formatting Markdown + files in the project. - `cog.toml`: [Cocogitto](https://docs.cocogitto.io) configuration file for managing versions. - - `cliff.toml`: [git-cliff](https://git-cliff.org) configuration file for - creating the changelog. + - `cliff.toml`: [git-cliff](https://git-cliff.org) configuration file for + creating the changelog. - `.copier-answers.yml`: Contains the answers you gave when copying the package from the template. **You should not modify this file directly.** - `.pre-commit-config.yaml`: [Pre-commit](https://pre-commit.com/) configuration