Skip to content

docs: complete the GitHub community standards checklist - #87

Merged
TheSaltyKorean merged 1 commit into
mainfrom
community/standards
Aug 26, 2026
Merged

docs: complete the GitHub community standards checklist#87
TheSaltyKorean merged 1 commit into
mainfrom
community/standards

Conversation

@TheSaltyKorean

Copy link
Copy Markdown
Owner

The repo's community profile
sat at 42% — only the description, README and license were in place. This
adds the four missing pieces, all under .github/ so the root stays clean.

  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1. Enforcement routes to
    @TheSaltyKorean via GitHub rather than publishing an email address. Adds one
    project-specific clause: filings and case details a contributor shares stay
    private.
  • CONTRIBUTING.md — the working rules that were previously only in
    CLAUDE.md: the Flutter 3.41.9 pin and why 3.44 fails (analyze passes but
    the build doesn't, which is a trap), the deliberate dependency pins, the
    pre-PR checklist, and the version-bump rule with the reason it exists.
  • SECURITY.md — points at private vulnerability reporting (already
    enabled on the repo) instead of the public tracker. States a realistic
    response window for a one-maintainer project, and pre-empts duplicate
    reports of the known file_picker 10.x pin by pointing at issue Security: upgrade file_picker to v11 (Android CWE-22 path traversal) once AppFlowy supports it #2.
  • PULL_REQUEST_TEMPLATE.md and ISSUE_TEMPLATE/ — a bug form, a
    feature form, and a config with contact links. The bug form asks for the
    minimal reproducing Markdown, which is the thing that actually makes a
    rendering bug fixable, and warns twice against attaching real filings.

Two notes on the templates:

  • blank_issues_enabled: true, because Discussions are off on this repo and
    otherwise a plain question would have nowhere to go. Say the word and I'll
    enable Discussions and add the contact link instead.
  • Both issue forms parse as valid YAML (checked locally).

Docs only — no app behaviour changed, so no version bump (rule 9).

Adds the four missing community-profile files under .github/: a Contributor
Covenant 2.1 code of conduct, a CONTRIBUTING guide carrying the Flutter pin
and version-bump rules that previously lived only in CLAUDE.md, a security
policy pointing at private vulnerability reporting, and issue/PR templates.

Blank issues stay enabled since Discussions are off on this repo.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3e7c6bcebd

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +67 to +68
contact the maintainer directly through GitHub, or use GitHub's
[report abuse](https://github.com/contact/report-abuse) form. All complaints

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Provide a private conduct-reporting channel

For reports involving private case details or maintainer conduct, this instruction leaves contributors without a way to contact the project privately: GitHub profiles do not provide direct messaging, and the linked Report Abuse form reports violations to GitHub rather than to this project's maintainer. Add a concrete private channel, such as a dedicated email address or private reporting form, so sensitive Code of Conduct complaints can actually reach the person responsible for enforcement.

Useful? React with 👍 / 👎.

@TheSaltyKorean
TheSaltyKorean merged commit 4353474 into main Aug 26, 2026
5 checks passed
@TheSaltyKorean
TheSaltyKorean deleted the community/standards branch August 26, 2026 17:03
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