Aleksei Sviridkin d205f31017 docs(agents): reword the section-banner comment rule (#5336)
## What this PR does

Rewords the comment rule in `docs/agents/contributing.md` that rejects
"section banners", so it describes the content it objects to instead of
a formatting style.

The rule exists to reject a comment that only names the code below it
and adds nothing, such as a heading over a `ClusterRole` whose `kind`
and `name` already say what it is. "Banners a section" reads instead as
an objection to decoration, and it gets applied to the shape:

```yaml
# == addresses view cluster role ==   <- rejected as a banner
# addresses view cluster role         <- passes, though it says exactly as little
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: cozy:addresses:view
```

The reverse also happens: a heading that does orient the reader in a
long file can be rejected for its `==`. Precedent in the tree shows how
unevenly the rule lands.
`packages/system/backup-controller/templates/tenant-clusterroles.yaml`
and
`packages/system/migration-controller/templates/tenant-clusterroles.yaml`
open their roles with `# == … ==` lines, and the rule only ever catches
new code.

The phrase changes in both places it appears:

- **In-code comments** blocker: "banners a section" becomes "merely
names the section below it".
- **Undisclosed machine authorship** tells: "section banners" becomes
"comments that merely name the section below them".

What the rules enforce is unchanged. The same comments are still
rejected; the wording just points a reviewer at the missing substance
rather than at the decoration.

### Screenshots

Not a UI change.

### Downstream repositories

- [x] No downstream repository is affected by this change
- [ ] [cozystack/website](https://github.com/cozystack/website) -
follow-up:
- [ ]
[cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack)
- follow-up:
- [ ]
[cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack)
- follow-up:
- [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up:
- [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up:
- [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) -
follow-up:
- [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) -
follow-up:
- [ ]
[cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server)
- follow-up:
- [ ]
[cozystack/external-apps-example](https://github.com/cozystack/external-apps-example)
- follow-up:
- [ ] [cozystack/examples](https://github.com/cozystack/examples) -
follow-up:
- [ ] [cozystack/community](https://github.com/cozystack/community) -
follow-up:

The trigger map's entries for this file, in cozystack/ccp and
cozystack/community, cover the commit convention, which this PR does not
touch. Neither repository restates the comment rules.

### Release note

```release-note
docs(agents): the comment rule against section banners now names what it rejects, a comment that merely names the section below it, rather than the banner formatting.
```


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

* **Documentation**
* Updated review-blocker guidance to clarify that comments merely naming
the section below them qualify as blockers, including in the examples.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-11-16 17:31:17 +03:00
2026-11-04 00:56:56 +01:00
2025-10-08 09:43:34 +05:00
2024-02-08 12:04:32 +01:00

Cozystack Cozystack

GitHub Release Apache-2.0 License Commit activity OpenSSF Best Practices OpenSSF Scorecard CLOMonitor Support

Cozystack

Cozystack is a free and open-source platform and framework for building clouds.

Cozystack is a CNCF Sandbox project that was originally built and sponsored by Ænix.

With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.

Use Cozystack to build your own cloud or provide a cost-effective development environment.

Cozystack user interface

Use-Cases

Documentation

The documentation is located on the cozystack.io website.

Read the Getting Started section for a quick start.

If you encounter any difficulties, start with the troubleshooting guide and work your way through the process that we've outlined.

Versioning

Versioning adheres to the Semantic Versioning principles.
A full list of the available releases is available in the GitHub repository's Release section.

Contributions

Contributions are highly appreciated and very welcomed!

In case of bugs, please check if the issue has already been opened by checking the GitHub Issues section. If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix.

You are welcome to take on the fix yourself. Commits are used to generate the changelog, and their author will be referenced in it.

If you have a concrete feature request, open an issue. For a cross-cutting or architectural change, open a design proposal in the community repo. For questions or early ideas, use GitHub Discussions. See CONTRIBUTING.md for the full routing.

Community

You are welcome to join us in #cozystack, on either CNCF Slack (get an invite) or Kubernetes Slack (get an invite), in our Telegram group, and at our community meetings. Add them to your Google Calendar or iCal for convenience.

Project documents

Document What it covers
Governance How decisions are made and who makes them
Contributor Ladder How to grow from contributor to maintainer
Maintainers Who maintains the project
Code of Conduct What we expect of each other
Security Policy Reporting a vulnerability, and which releases get fixes
Adopters Who runs Cozystack in production
Roadmap Where the project is going

License

Cozystack is licensed under Apache 2.0.
The code is provided as-is with no warranties.

Commercial Support

A list of companies providing commercial support for this project can be found on official site.

Languages
Go 52%
Shell 34%
TypeScript 6.8%
Go Template 4.7%
Makefile 1.3%
Other 1.1%