Skip to content

Mir help reference rules #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 23, 2025
Merged

Mir help reference rules #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88d5433
MIR: fix whitespace damage
cpaelzer Jun 20, 2025
a8881fc
MIR: add line numbers to templates
cpaelzer Jun 20, 2025
5e80228
MIR: drop the not yet supported lineanchors feature
cpaelzer Jun 20, 2025
2b691c3
Merge branch 'main' into mir-help-reference-rules
s-makin Jun 23, 2025
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
6 changes: 4 additions & 2 deletions docs/MIR/mir-reporters-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ This section is a guideline for the **reporter** as they are
* Make the future owning team think about common issues

* Provide the detail needed by the **reviewer** to decide:
*Can this package be well maintained in `main`?*
*Can this package be well maintained in `main`?*

Usage follows {ref}`mir-how-to-use-templates`.

```
```{code-block} text
:linenos:

[Availability]
TODO: The package TBDSRC is already in Ubuntu universe.
TODO: The package TBDSRC build for the architectures it is designed to work on.
Expand Down
4 changes: 3 additions & 1 deletion docs/MIR/mir-reviewers-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Usage follows {ref}`mir-how-to-use-templates`.
* Issues to be addressed should go to the **Problem:** sections (and briefly
the **[Summary]** at the top of the template).

```
```{code-block} text
:linenos:

RULE: Since we sometimes have many such posts on one bug, in case multiple
RULE: packages are associated, clearly state which one this is for.
TODO: Review for Source Package: TBDSRC
Expand Down
Loading