docs(ai): Create build-script.md for Claude Code / Restore CHANGELOG.md#132
Merged
Conversation
This reverts commit 1b56d52.
CHANGELOG.md
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to support AI-assisted development workflows and project history tracking by introducing a build script guide for Claude Code and restoring the project's changelog.
- Adds automated build workflow documentation for Claude Code
- Restores comprehensive version history from v1.3.7 to v2.1.2
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CHANGELOG.md | Adds version history tracking from v1.3.7 (2021-08-29) through v2.1.2 (2025-12-16) with release comparison links |
| .claude/commands/build-script.md | Provides step-by-step build and commit instructions for Claude Code automation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. Run `npm install` to install dependencies | ||
| 2. Run `npm run package` to build the project | ||
| 3. If the build succeeds, stage all changes with `git add -A ./dist` | ||
| 4. Commit the changes with the message and co-author: "build: rebuild dist" |
There was a problem hiding this comment.
The commit message on line 6 is incomplete. It should specify the actual co-author information in the proper Git format. The current instruction "with the message and co-author: 'build: rebuild dist'" is ambiguous. It should either:
- Clarify the co-author format (e.g., "Co-authored-by: Name [email protected]")
- Or remove the co-author reference if not needed
The proper Git commit message format with co-author should be:
build: rebuild dist
Co-authored-by: Name <[email protected]>
Suggested change
| 4. Commit the changes with the message and co-author: "build: rebuild dist" | |
| 4. Commit the changes with the message: "build: rebuild dist" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces documentation updates to the project. It adds a new build script guide and creates a changelog file to track version history and notable changes.
Documentation updates:
.claude/commands/build-script.mdfile with step-by-step instructions for building and committing the project artifacts.CHANGELOG.mdfile to document version history and summarize changes for each release.