Skip to content

Commit 2a354b4

Browse files
mithroclaude
andcommitted
docs: add AI-assisted development warning notice
Add prominent warnings to README and documentation alerting users that this project was developed using AI-assisted "vibe coding" with Claude Code, similar to the git-cache repository. ## Changes - Add warning banner in README.md after badges - Add warning box in docs/source/index.rst using Sphinx warning directive - Alerts users to verify results with their specific toolchain - Notes potential edge cases with different MSVC configurations ## Rationale Transparency about AI-assisted development helps set appropriate expectations and encourages users to validate the tool with their specific use cases before production use. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 7bded05 commit 2a354b4

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[![Python Version](https://img.shields.io/pypi/pyversions/msvcpp-normalize-pe.svg)](https://pypi.org/project/msvcpp-normalize-pe/)
66
[![Tests](https://github.com/mithro/msvcpp-normalize-pe/workflows/Test%20%26%20Lint/badge.svg)](https://github.com/mithro/msvcpp-normalize-pe/actions)
77

8+
**⚠️ AI-Assisted Development Notice: This project was developed as an experiment in AI-assisted "vibe coding" using Claude Code. While the code has comprehensive tests and linting, it was primarily generated through AI assistance. The implementation is based on reverse-engineering PE file formats and may have edge cases or behaviors that haven't been thoroughly tested with all possible MSVC configurations. Use with caution in production environments and verify results with your specific toolchain.**
9+
810
A Python tool to patch Windows PE (Portable Executable) files to make MSVC builds reproducible by normalizing timestamps, GUIDs, and other non-deterministic debug metadata.
911

1012
## The Problem

docs/source/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ msvcpp-normalize-pe Documentation
33

44
**Normalize PE files for reproducible MSVC++ builds**
55

6+
.. warning::
7+
**AI-Assisted Development Notice**
8+
9+
This project was developed as an experiment in AI-assisted "vibe coding" using Claude Code.
10+
While the code has comprehensive tests and linting, it was primarily generated through AI
11+
assistance. The implementation is based on reverse-engineering PE file formats and may have
12+
edge cases or behaviors that haven't been thoroughly tested with all possible MSVC
13+
configurations. Use with caution in production environments and verify results with your
14+
specific toolchain.
15+
616
``msvcpp-normalize-pe`` is a Python tool that patches Windows PE (Portable Executable)
717
files to make MSVC builds reproducible by normalizing timestamps, GUIDs, and other
818
non-deterministic debug metadata.

0 commit comments

Comments
 (0)