Skip to content

Add fork maintainer community baseline and support policy - #34

Merged
kgrizz-git merged 2 commits into
mainfrom
docs/fork-maintainer-community-baseline
Jul 26, 2026
Merged

kgrizz-git merged 2 commits into
mainfrom
docs/fork-maintainer-community-baseline

Conversation

@kgrizz-git

@kgrizz-git kgrizz-git commented Jul 26, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add CONTRIBUTING, SUPPORT, SECURITY, CODE_OF_CONDUCT, GOVERNANCE, CITATION.cff, privacy-aware issue forms, and a PR template.
  • Document intended use (research/education/QA, not FDA-cleared; clinicians responsible for patient-care decisions) and welcome ideas/submissions via Issues/Discussions rather than cold PRs.
  • Enable Issues + Discussions on the repo; fix README docs install and migration-status packaging notes; refresh fork-maintainer guide status.

Test plan

  • Pre-commit hooks passed on commit (sensitive-content, privacy receipts, doc freshness, notices)
  • Confirm GitHub Issues and Discussions UI show the new templates/contact links after merge
  • Spot-check README intended-use and CONTRIBUTING wording on the PR diff

Made with Cursor

Summary by CodeRabbit

  • Documentation

    • Updated project identity and clarified intended-use limits, attribution, and fork guidance.
    • Added contribution, governance, security, support, and code-of-conduct policies, plus citation metadata.
    • Strengthened privacy expectations for submitting issues, logs, and incident reports.
  • Community

    • Added structured templates for bug reports, feature requests, and pull requests.
  • Release & Maintenance

    • Improved release-publishing safeguards.
    • Updated scanning/analysis approach to include GUI coverage and privacy-gated execution ordering, with updated CI notes.

Ship privacy-aware Issues/Discussions guidance, intended-use disclaimer,
and contribution docs so the public fork has clear channels without a cold-PR queue.
@coderabbitai

coderabbitai Bot commented Jul 26, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bd01013d-51e1-4ef9-91a9-f16f8965dc2c

📥 Commits

Reviewing files that changed from the base of the PR and between 4ac6453 and f32ee00.

📒 Files selected for processing (9)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • GOVERNANCE.md
  • README.md
  • SECURITY.md
  • SUPPORT.md
🚧 Files skipped from review as they are similar to previous changes (9)
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • CODE_OF_CONDUCT.md
  • SUPPORT.md
  • GOVERNANCE.md
  • SECURITY.md
  • README.md
  • CHANGELOG.md
  • CONTRIBUTING.md

📝 Walkthrough

Walkthrough

The pull request establishes MyPySkinDose’s fork identity and maintainer metadata, adds governance, contribution, support, security, and conduct documentation, introduces structured GitHub intake templates, updates project guidance, and pins the PyPI publishing action to an immutable commit.

Changes

Project stewardship

Layer / File(s) Summary
Fork identity and project metadata
README.md, CITATION.cff, pyproject.toml, CHANGELOG.md
Updates fork identity, intended-use guidance, documentation setup, citation metadata, maintainer metadata, and unreleased maintenance notes.
Contribution, governance, and safety policies
CONTRIBUTING.md, GOVERNANCE.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, AGENTS.md
Defines contribution workflows, maintainer responsibilities, privacy restrictions, security reporting, support channels, community conduct, and contributor guidance.
Structured contribution intake
.github/ISSUE_TEMPLATE/*, .github/pull_request_template.md
Adds structured bug and feature forms, contact links, privacy confirmations, and pull request checklist sections.
Pinned package publishing action
.github/workflows/release.yml
Pins the PyPI publishing action to an immutable commit SHA.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main change: adding fork-maintainer community and support policy documentation plus related templates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fork-maintainer-community-baseline

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Note

Unit test generation is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it.


Generating unit tests... This may take up to 20 minutes.

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Request timed out after 900000ms (requestId=c2bf52dc-106b-45f2-b036-3a0accb0d055)

@kgrizz-git

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 26, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai 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.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/bug_report.yml:
- Around line 20-27: Update the required no-phi checkbox option in the “Privacy
confirmation” block to include identified screenshots, private URLs, and full
unredacted logs alongside the existing PHI/PII, clinical RDSR, credential, and
institutional identifier prohibitions. Keep the checkbox required and mirror the
complete warning list.

In `@GOVERNANCE.md`:
- Around line 32-34: Update the maintainer-transition checklist in GOVERNANCE.md
to also require synchronizing CONTRIBUTING.md and SECURITY.md, alongside the
existing files and pyproject.toml maintainer metadata.

In `@README.md`:
- Line 315: Update the Bugs and features GitHub Issues description in README.md
to state that the templates require a no-PHI/PII confirmation, and add a
direction for users to consult the privacy policy; do not claim the templates
enforce privacy.

In `@SUPPORT.md`:
- Around line 26-30: Define one concrete supported private intake channel for
privacy and conduct incidents, document it in SUPPORT.md, and use the identical
channel consistently in SECURITY.md and CODE_OF_CONDUCT.md. Update SUPPORT.md
lines 26-30 to name the channel, SECURITY.md lines 30-34 to replace “contact the
maintainer privately,” and CODE_OF_CONDUCT.md lines 61-65 to replace private
GitHub contact wording.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5ae68829-ca65-4b7f-aeb2-e7e4161227b3

📥 Commits

Reviewing files that changed from the base of the PR and between 28bfebf and 4ac6453.

⛔ Files ignored due to path filters (5)
  • dev-docs/FORK_MAINTAINER_GUIDE.md is excluded by !dev-docs/**
  • dev-docs/MYPYSKINDOSE_MIGRATION_STATUS.md is excluded by !dev-docs/**
  • dev-docs/THIRD_PARTY_NOTICES.md is excluded by !dev-docs/**
  • dev-docs/TO_DO.md is excluded by !dev-docs/**
  • dev-docs/index.md is excluded by !dev-docs/**
📒 Files selected for processing (15)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • .github/workflows/release.yml
  • AGENTS.md
  • CHANGELOG.md
  • CITATION.cff
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • GOVERNANCE.md
  • README.md
  • SECURITY.md
  • SUPPORT.md
  • pyproject.toml

Comment thread .github/ISSUE_TEMPLATE/bug_report.yml Resolved
Comment thread GOVERNANCE.md Resolved
Comment thread README.md Resolved
Comment thread SUPPORT.md Resolved
Align issue-template privacy checkboxes, clarify Issues wording, expand
maintainer-transition checklist, and use private vulnerability reporting as
the shared private intake for security, privacy, and CoC reports.
@github-actions

Copy link
Copy Markdown

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 26, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@kgrizz-git
kgrizz-git merged commit b5fa892 into main Jul 26, 2026
15 checks passed
@kgrizz-git
kgrizz-git deleted the docs/fork-maintainer-community-baseline branch July 26, 2026 16:22
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