WIP: create a template for reporting bugs #44
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a new "bogus" template for bug reporting and regression testing, along with minor documentation improvements to the default template's example aspects file.
- Adds a new
templates/bogustemplate structure for creating minimal den setups to reproduce bugs and serve as CI regression tests - Updates comment documentation in the default template's aspects.nix to clarify configuration examples
- Provides infrastructure for tracking and testing bug fixes with issue-numbered module directories
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/default/modules/_example/aspects.nix | Updated comments to clarify static aspect inclusion scope and removed redundant comment text |
| templates/bogus/README.md | Added comprehensive documentation for the bug reporting template workflow and rules |
| templates/bogus/flake.nix | Created flake configuration with all necessary dependencies for den bug reproduction |
| templates/bogus/flake.lock | Added lock file with pinned dependency versions |
| templates/bogus/modules/shared/home-manager.nix | Added home-manager input configuration |
| templates/bogus/modules/shared/enable.nix | Added empty enable module stub |
| templates/bogus/modules/shared/dendritic.nix | Added dendritic flake module configuration |
| templates/bogus/modules/_0_success/ci.nix | Added success case example using den.lib.check |
| templates/bogus/enabled.nix | Added configuration to enable issue number 0 (success case) by default |
| templates/bogus/.gitignore | Added gitignore to exclude generated enabled.nix file |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
templates/bogus/README.md
Outdated
| nix fmt | ||
| nix flake check | ||
| # loop until success | ||
| `` |
There was a problem hiding this comment.
The code block is not properly closed. The closing triple backticks are missing, which will cause the markdown to not render correctly.
| `` |
templates/bogus/README.md
Outdated
| We keep these checks outside `templates/default/_example` | ||
| because even when \_example is run by CI, they are intended | ||
| for people to learn about den features. So we try to minimize | ||
| the noice for them. Of course, your bug fix might require |
There was a problem hiding this comment.
Spelling error: "noice" should be "noise".
| the noice for them. Of course, your bug fix might require | |
| the noise for them. Of course, your bug fix might require |
templates/bogus/README.md
Outdated
| - No external dependencies. | ||
|
|
||
| Do not add dependencies to other flakes, like disko, | ||
| or anything unless we have agreeded in a discussion. |
There was a problem hiding this comment.
Spelling error: "agreeded" should be "agreed".
| or anything unless we have agreeded in a discussion. | |
| or anything unless we have agreed in a discussion. |
templates/bogus/README.md
Outdated
| ## Clone this template | ||
|
|
||
| ```console | ||
| mkdir bugus && cd bugus |
There was a problem hiding this comment.
Spelling error: "bugus" should be "bogus" to match the template name.
| mkdir bugus && cd bugus | |
| mkdir bogus && cd bogus |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 6 out of 8 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
and for regression testing