From 46e872f4913b3811e8fb798d5bb003903e9e937d Mon Sep 17 00:00:00 2001 From: Raphael Das Gupta Date: Fri, 6 Jan 2023 16:19:52 +0100 Subject: [PATCH 1/2] issue template: remove bullet list A bullet list would make sense if the code blocks would be part of the items. To make a code block part of a list item in Markdown, it would though have to be indented which is either too laborious (when indenting all lines) or too confusing (when indenting only the opening line). If they aren't indented, they'd interrupt the list (thus effectively splitting it into 3 one-item lists) so let's instead just have the file names as prose-ish captions of the code blocks. --- .github/ISSUE_TEMPLATE/issue-template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md index 287c9a3..9c54ff8 100644 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ b/.github/ISSUE_TEMPLATE/issue-template.md @@ -25,14 +25,14 @@ Community will happily help to find soulution and if needed create issue or pull Note that while these aren't strict requirements it will heavily increase your chances to get an issue fixed if you include more context that makes it possible to recreate the issue. --> -- `default.nix`/`shell.nix`/`flake.nix` +`default.nix`/`shell.nix`/`flake.nix`: ``` ``` -- `pyproject.toml` +`pyproject.toml`: ``` ``` -- `poetry.lock` +`poetry.lock`: ``` ``` From f68311cf533e29632eec5d0bb27ef76e4c086cd6 Mon Sep 17 00:00:00 2001 From: Raphael Das Gupta Date: Fri, 6 Jan 2023 16:22:13 +0100 Subject: [PATCH 2/2] issue template: add syntax highlighting We do know what languages we expect in the files we ask the issue author to provide in the "Additional context" section, so let's set up proper syntax highlighting for them. --- .github/ISSUE_TEMPLATE/issue-template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md index 9c54ff8..04f34b3 100644 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ b/.github/ISSUE_TEMPLATE/issue-template.md @@ -26,13 +26,13 @@ Note that while these aren't strict requirements it will heavily increase your c --> `default.nix`/`shell.nix`/`flake.nix`: -``` +```nix ``` `pyproject.toml`: -``` +```toml ``` `poetry.lock`: -``` +```toml ```