Closed
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the repo for the v1.1.0 release by bringing public-facing documentation and package metadata into alignment with the current feature set and release versioning.
Changes:
- Refreshed
README.mdto reflect current functionality (boards/super-boards, membership model, invite flow, transactions, export) and updated dev/deploy guidance. - Reworked
SECURITY.mdto clarify supported versions (1.1.x) and establish private vulnerability reporting guidance. - Added a
CHANGELOG.mdand aligned package versions/lockfiles to1.1.0.
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Updates supported-versions policy and private vulnerability reporting instructions. |
| README.md | Rewrites product + developer documentation to match current architecture, features, and workflows. |
| CHANGELOG.md | Introduces Keep-a-Changelog-style release notes including 1.1.0. |
| package.json | Bumps frontend package version to 1.1.0. |
| package-lock.json | Aligns lockfile metadata with 1.1.0 (and reflects lockfile regeneration). |
| functions/package.json | Bumps functions package version to 1.1.0. |
| functions/package-lock.json | Aligns functions lockfile metadata with 1.1.0. |
Files not reviewed (1)
- functions/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Owner
Author
|
#67 Will do the same but better. |
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.
Motivation
v1.1.0release by bringing all public-facing documentation into sync with the current code and feature set.Description
README.mdto accurately describe the current app (boards, one-level super-board hierarchy, direct vs inherited membership, invite flow, transaction create/edit/delete, negative amounts, future-dated transaction dates, and Excel export including super-board multi-sheet + summary behavior), developer setup, env variables, and deployment workflows.SECURITY.mdwith a supported-versions table (marking1.1.xsupported), private reporting guidance via GitHub security workflows, realistic disclosure expectations, and scope notes.CHANGELOG.md(Keep-a-Changelog style) withUnreleased,1.1.0, and minimal historical1.0.xentries describing user-facing changes.1.1.0inpackage.jsonandfunctions/package.jsonand updated lockfiles (package-lock.json,functions/package-lock.json) to reflect the version alignment; no application behavior changes were introduced.Testing
npm run buildwhich completed successfully (production build via Vite).npm run lintwhich surfaced pre-existing frontend ESLint errors (the lint step failed; these issues were not introduced by this docs/metadata change).npm --prefix functions run lintwhich intentionally skips lint and completed (functions lint script is a placeholder).Codex Task