Skip to content

Establish Comic Sol Lab as canonical public repository - #13

Merged
wenn-id merged 1 commit into
mainfrom
docs/public-product-primary
Jul 30, 2026
Merged

Establish Comic Sol Lab as canonical public repository#13
wenn-id merged 1 commit into
mainfrom
docs/public-product-primary

Conversation

@wenn-id

@wenn-id wenn-id commented Jul 30, 2026

Copy link
Copy Markdown
Owner

Summary

  • establish wenn-id/comic-sol-lab as Comic Sol's canonical independent public home
  • move public clone/install links away from the Build Week repository
  • make main the only canonical push CI branch
  • add contribution and private security-reporting policies
  • add a regression contract preventing public surfaces from reverting to the event repository

Verification

  • packaging contracts: 6 passed
  • full suite: 340 passed, 1 skipped
  • wheel and source distribution build/validation: pass
  • diff hygiene: pass

@warpfix

warpfix Bot commented Jul 30, 2026

Copy link
Copy Markdown

🔍 WarpFix PR Review

This pull request establishes the wenn-id/comic-sol-lab repository as the canonical public repository for Comic Sol, moving public links from the Build Week repository and implementing new contribution and security policies.

📖 Walkthrough

The changes include modifications to the GitHub Actions workflow to restrict CI to the main branch, the addition of a CONTRIBUTING.md file that outlines the development setup and validation requirements, and a SECURITY.md file detailing the security policy and reporting procedures. The README.md has been updated to reflect the new repository as the canonical home for Comic Sol, and the tests/test_validation.py file has been enhanced with a new test to ensure that the public surfaces correctly reference the new repository. Overall, these changes aim to clarify the repository's purpose and improve the development and security processes.

📁 File Changes

File Change Impact
.github/workflows/tests.yml Modified CI workflow to restrict pushes to the main branch only. 🔴 high
CONTRIBUTING.md Added a new file detailing contribution guidelines and validation requirements. 🔴 high
README.md Updated to reflect the new canonical repository and installation instructions. 🟡 medium
SECURITY.md Introduced a new file outlining the security policy and reporting vulnerabilities. 🔴 high
tests/test_validation.py Added a test to ensure public surfaces reference the new canonical repository. 🟡 medium

⏱ Review Effort & Risk

Metric Value
Effort ███░░ 3/5 (Moderate) · ~30min
Risk 🟡 MEDIUM
Risk Factors
  • Changes to CI workflow may affect build stability if not properly tested.
  • New contribution and security policies need to be communicated effectively to contributors.
  • Potential for confusion if users are not aware of the repository change.

Labels: enhancement documentation security

💡 Key Observations

Ensure that all contributors are aware of the new repository and its policies.

Verify that the CI changes do not disrupt existing workflows.

Consider adding a migration guide for users transitioning from the old repository.


🤖 Reviewed by WarpFix — AI-Powered Code Review + CI Repair · Security

@@ -2,9 +2,8 @@ name: Tests

on:
push:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Warning logic

Restricting the workflow to only the 'main' branch may prevent testing on other branches that could be important for development.

Suggested change
push:
Consider adding other branches back to the workflow if they are actively used.

🤖 WarpFix

Comment thread CONTRIBUTING.md
Use Python 3.11 and the pinned dependencies:

```bash
python3.11 -m venv .venv

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Praise documentation

Great job outlining the development setup clearly, including the use of a virtual environment.

🤖 WarpFix

Comment thread CONTRIBUTING.md
python3.11 -m comic_sol_product.release dist/*.whl dist/*.tar.gz
```

Changes to packaging, runtime freezing, MCP, release automation, or distribution must also pass clean-install and portable-runtime smoke tests. Visual output changes require an actual before/after render and visual inspection; green geometry tests alone are insufficient.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Warning documentation

The instructions for running tests could benefit from specifying the expected output or behavior.

Suggested change
Changes to packaging, runtime freezing, MCP, release automation, or distribution must also pass clean-install and portable-runtime smoke tests. Visual output changes require an actual before/after render and visual inspection; green geometry tests alone are insufficient.
Add a note about what passing tests should look like.

🤖 WarpFix

Comment thread CONTRIBUTING.md
- Target `main`.
- Explain user-visible behavior and migration impact.
- Add or update deterministic tests for behavior changes.
- Preserve the exact 17-tool MCP surface unless a separately reviewed contract change explicitly updates it.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Warning documentation

The requirement for visual inspection of changes is good, but it may be too vague for contributors.

Suggested change
- Preserve the exact 17-tool MCP surface unless a separately reviewed contract change explicitly updates it.
Provide examples of what constitutes sufficient visual inspection.

🤖 WarpFix

Comment thread README.md
@@ -6,6 +6,10 @@ invocation drives planning, character consistency, image generation, visual QA,
selective repair, deterministic lettering and composition, and PDF export. It is
not a web app or hosted product. No build service is required.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Praise documentation

Excellent addition of the canonical repository link, which clarifies the project's home.

🤖 WarpFix

Comment thread README.md
is the canonical, independent home of Comic Sol. New development, issues, pull
requests, documentation, and releases happen here.

## Install

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Warning documentation

The clone command should specify the correct repository to avoid confusion.

Suggested change
## Install
Ensure the command reflects the canonical repository: `git clone https://github.com/wenn-id/comic-sol-lab.git`.

🤖 WarpFix

Comment thread SECURITY.md

- affected version or commit;
- reproduction steps and impact;
- operating system and installation method;

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🚨 Critical security

The document should emphasize the importance of not including live secrets when reporting vulnerabilities.

Suggested change
- operating system and installation method;
Add a clear statement at the beginning of the section about the handling of sensitive information.

🤖 WarpFix

Comment thread SECURITY.md
Do not include live secrets. Revoke exposed credentials before reporting and replace values with `[REDACTED]`.

## Scope

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Praise security

The detailed reporting structure for vulnerabilities is well thought out and comprehensive.

🤖 WarpFix

Comment thread tests/test_validation.py
@@ -949,6 +949,17 @@ def test_readme_is_judge_runnable_without_a_build_service(self):
self.assertIn(required, readme)
self.assertNotRegex(readme.lower(), r"npm run|start the server|docker compose")

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Praise testing

The test for verifying the canonical repository link is a great addition to ensure documentation accuracy.

🤖 WarpFix

Comment thread tests/test_validation.py
self.assertNotRegex(readme.lower(), r"npm run|start the server|docker compose")

def test_public_surface_uses_the_canonical_independent_repository(self):
readme = self.readme()

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Warning testing

Ensure that the test for the workflow file checks for all relevant branches, not just the main branch.

Suggested change
readme = self.readme()
Consider adding assertions for any other branches that should be included.

🤖 WarpFix

@wenn-id
wenn-id merged commit 6d6fdd3 into main Jul 30, 2026
7 checks passed
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