Skip to content

chore: Add governance md documentation - #1591

Open
dianab-cl wants to merge 5 commits into
mainfrom
diana/fou-1156-governancemd-referencing-the-tsc-csl-05
Open

dianab-cl wants to merge 5 commits into
mainfrom
diana/fou-1156-governancemd-referencing-the-tsc-csl-05

Conversation

@dianab-cl

Copy link
Copy Markdown
Contributor

Description

closes: #XXXX


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Include changelog entry when appropriate (e.g. chores should be omitted from changelog).
  • Wrote unit and e2e tests if relevant.
  • Updated documentation (docs/) if anything is changed.
  • Added godoc comments if relevant.
  • Self-reviewed Files changed in the GitHub PR explorer.
  • Provide a conventional commit message to follow the repository standards.

Signed-off-by: Diana Borbe <diana@cosmoslabs.io>
@dianab-cl
dianab-cl requested a review from a team as a code owner October 21, 2026 12:00
@linear-code

linear-code Bot commented Oct 21, 2026

Copy link
Copy Markdown

FOU-1156

@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Vulnerable dependencies

2 advisories across 2 libraries need attention, 2 accepted.

🚨 Needs attention

github.com/cosmos/evm

In use: v0.7.3 — reached from e2e

Advisory CVE Fixed in Summary
GO-2025-3684 — no fix yet Cosmos EVM Allows Partial Precompile State Writes in github.com/cosmos/evm

Go standard library

In use: go1.26.9 — reached from cli, e2e, gen/go/solidity-abi

Advisory CVE Fixed in Summary
GO-2026-6809 CVE-2026-111943 go1.26.10 Distrust compromised intermediate certificates in crypto/x509

Run make vulncheck for the call paths. Either upgrade the library, or add the
advisory to .govulncheck-ignore with a reason if no fix exists yet.

Accepted

Listed in .govulncheck-ignore with a reason.

github.com/pion/dtls/v2

In use: v2.2.12 — reached from cli

Advisory CVE Fixed in Summary
GO-2026-4479 CVE-2026-26014 no fix yet Usage of random nonce generation with AES GCM ciphers risks leaking the authentication key in github.com/pion/dtls

golang.org/x/crypto

In use: v0.57.0 — reached from cli, e2e

Advisory CVE Fixed in Summary
GO-2026-5932 — no fix yet The golang.org/x/crypto/openpgp package is unmaintained, unsafe by design, and has known security issues

From make vulncheck-json on this run: logs.

@greptile-apps

greptile-apps Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The PR appears safe to merge, with no blocking findings; several earlier documentation concerns remain.

Findings

  1. P2 License instructions conflict ▶
  2. P2 Changelog instructions conflict ▶
  3. P2 Conduct contacts are missing ▶
  4. P2 The charter is unreachable ▶
  5. P2 Governance forum is unnamed ▶
  6. P2 Supported versions are unspecified ▶
  7. P2 Voting lists disagree ▶

Summary

Adds project guidance for governance, contributions, releases, security, conduct, maintainers, and adopters.

  • Contributors and maintainers now have a documented path for decisions.
  • IBC now has a written path for vulnerability reports and disclosure.
  • GitHub intake now uses focused bug and feature forms.
  • Adopters now have written guidance on IBC releases.
  • IBC now has a list for known and self-reported adopters.

Reviews (2) · Last reviewed commit: "After code review" · Reviewed by Greptile

Comment thread ADOPTERS.md
Comment thread CONTRIBUTING.md

## Copyright and license

Code is contributed under Apache 2.0, specifications under the Community Specification License 1.0, and documentation under CC BY 4.0, regardless of where in the repository the file lives. The SPDX header on each file records which applies.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 License instructions conflict

CONTRIBUTING.md says specifications use the Community Specification License and documentation uses CC BY 4.0, but existing files still say Apache 2.0. The specification template also tells contributors to use Apache 2.0, and .licenserc.yaml says the specification conversion is separate. Keep this guidance aligned with the current licenses until that conversion lands.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment thread CONTRIBUTING.md

## Changelog

The changelog is generated from Conventional Commit titles at release time, so a well-formed pull request title is what matters rather than a hand-written entry. CI checks the title format.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Changelog instructions conflict

This tells contributors that a handwritten changelog entry is unnecessary, but CHANGELOG.md still requires entries under its unreleased section, and the pull request template still asks for them. The release workflows have no step that generates the changelog. Keep the existing instructions until generation is added, or update the release process and its instructions together. The same claim appears in RELEASES.md.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment thread CODE_OF_CONDUCT.md Outdated

All participants in project spaces, including repositories, issues, pull requests, discussions, community calls, and chat, are expected to uphold it in all interactions.

To report a concern, contact the project's Code of Conduct responders listed in TSC_MEMBERS.md, or escalate to LFDT per the process in the linked Code of Conduct.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Conduct contacts are missing

Neither reporting route is usable as written: TSC_MEMBERS.md lists the Code of Conduct responders as [TBD], and the supposedly linked LFDT Code of Conduct has no link. Add a real confidential contact and the LFDT policy URL so participants can report concerns.

Comment thread GOVERNANCE.md

## Full charter

See the IBC Project Technical Charter for the complete governance model, including the TSC's responsibilities, how Maintainers are chosen, and the amendment process.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The charter is unreachable

The full charter is neither included nor linked. Other sections defer to it for rules such as maintainer inactivity and removal, so readers cannot look up those rules. Link the approved Technical Charter here.

Comment thread CONTRIBUTING.md Outdated
- GitHub pull requests for ADRs, code, docs, and specs.
- Community calls, open to all and recorded, with a public calendar, for synchronous design and roadmap.
- Community chat on the LFDT Discord for questions and coordination.
- The governance forum named in MAINTAINERS.md for formal and asynchronous governance decisions.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Governance forum is unnamed

MAINTAINERS.md does not name a governance forum. Contributors following this reference cannot find the stated place for formal governance discussions. Add the actual forum name and link there, or replace this instruction with the venue contributors should use.

Comment thread RELEASES.md

| Release line | Status | Supported until |
| --- | --- | --- |
| [TBD] | Supported | [TBD] |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Supported versions are unspecified

The supported-version table contains only [TBD], but SECURITY.md uses it to define which release lines receive security fixes. List the supported lines for each component, or explicitly state that none are supported yet, before publishing this policy.

Comment thread MAINTAINERS.md

## Technical Steering Committee

The TSC is the set of Maintainers listed above. Each is a voting member with one vote. The TSC elects a Chair.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Voting lists disagree

Giovanni Vitali is listed as Chair but omitted from the maintainer table. This file defines the TSC as exactly the maintainers listed above, while TSC_MEMBERS.md explicitly lists him as a voting maintainer. Add him to the maintainer table so the documents agree on membership and vote counts.

Comment thread SECURITY.md Outdated
Signed-off-by: Diana Borbe <diana@cosmoslabs.io>
Signed-off-by: Diana Borbe <diana@cosmoslabs.io>
@dianab-cl

Copy link
Copy Markdown
Contributor Author

@greptile review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant