Skip to content

Commit

Permalink
docs: improve bot comment
Browse files Browse the repository at this point in the history
  • Loading branch information
aeddi committed Dec 2, 2024
1 parent 5c1edda commit 59c3ad6
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions contribs/github-bot/internal/check/comment.tmpl
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Merge Requirements
I'm a bot that assists the Gno Core team in maintaining this repository. My role is to ensure that contributors understand and follow our guidelines, helping to streamline the development process.

The following requirements must be fulfilled before a pull request can be merged.
Some requirement checks are automated and can be verified by the CI, while others need manual verification by a staff member.

These requirements are defined in this [configuration file](https://github.com/GnoCheckBot/demo/blob/main/config.go).
These requirements are defined in this [configuration file](https://github.com/gnolang/gno/tree/master/contribs/github-bot/internal/config/config.go).

## Automated Checks

{{ range .AutoRules }} {{ if .Satisfied }}🟢{{ else }}🔴{{ end }} {{ .Description }}
{{ end }}
{{ if .AutoRules }}{{ range .AutoRules }} {{ if .Satisfied }}🟢{{ else }}🔴{{ end }} {{ .Description }}
{{ end }}{{ else }}*No automated checks match this pull request.*{{ end }}

## Manual Checks

{{ if .AutoRules }}<details><summary><b>Details</b></summary><blockquote>
{{ if .ManualRules }}{{ range .ManualRules }}- [{{ if .CheckedBy }}x{{ else }} {{ end }}] {{ .Description }}{{ if .CheckedBy }} (checked by @{{ .CheckedBy }}){{ end }}
{{ end }}{{ else }}*No manual checks match this pull request.*{{ end }}

{{ if or .AutoRules .ManualRules }}<details><summary><b>Debug</b></summary><blockquote>
{{ if .AutoRules }}<details><summary><b>Automated Checks</b></summary><blockquote>
{{ range .AutoRules }}
<details><summary>{{ .Description | stripLinks }}</summary><blockquote>

Expand All @@ -25,14 +31,9 @@ These requirements are defined in this [configuration file](https://github.com/G
</blockquote></details>
{{ end }}
</blockquote></details>
{{ else }}*No automated checks match this pull request.*{{ end }}

## Manual Checks

{{ range .ManualRules }}- [{{ if .CheckedBy }}x{{ else }} {{ end }}] {{ .Description }}{{ if .CheckedBy }} (checked by @{{ .CheckedBy }}){{ end }}
{{ end }}

{{ if .ManualRules }}<details><summary><b>Details</b></summary><blockquote>
{{ if .ManualRules }}<details><summary><b>Manual Checks</b></summary><blockquote>
{{ range .ManualRules }}
<details><summary>{{ .Description | stripLinks }}</summary><blockquote>

Expand All @@ -48,4 +49,6 @@ These requirements are defined in this [configuration file](https://github.com/G
</blockquote></details>
{{ end }}
</blockquote></details>
{{ else }}*No manual checks match this pull request.*{{ end }}
{{ end }}
</blockquote></details>
{{ end }}

0 comments on commit 59c3ad6

Please sign in to comment.