Conversation
- Fix Quick Start example: `scopes` → `scope` (matches actual schema) - Add missing resources to features list (JWK, workspace, project, identity schemas) - Add data sources section to features list - Fix testing section: document pre-created project setup with .env - Expand development section with make tools, hooks, install targets - Add duration format warning (API normalizes durations, use full format) - Add known limitations section from actual resource behaviors - Add pre-commit checklist and security scanning documentation - Complete templates directory tree (was showing 5 of 16 templates) - Update contributing section to reference CONTRIBUTING.md - Remove CHANGELOG.md (links pointed to old jasonhernandez repo)
There was a problem hiding this comment.
Pull request overview
This pull request updates the README.md documentation with significant improvements to structure, clarity, and completeness. It also removes the CHANGELOG.md file entirely. The README changes include better organization of features (separating Resources and Data Sources), updated build instructions, corrected example code, expanded development and testing documentation, and new sections on duration formats, known limitations, pre-commit checklists, and security scanning.
Changes:
- Enhanced README.md with better structure, expanded development/testing sections, and new reference sections (Duration Format, Known Limitations, Pre-Commit Checklist, Security Scanning)
- Fixed incorrect field name in example code (
scopes→scopefor social provider) - Updated build instructions from direct
go buildtomake buildcommand - Removed CHANGELOG.md file completely
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Comprehensive documentation improvements including reorganized features section, expanded development/testing guides, corrected code examples, and new reference sections for developers |
| CHANGELOG.md | Complete file deletion (only contained initial v0.1.0 release notes) |
Comments suppressed due to low confidence (1)
CHANGELOG.md:1
- The entire CHANGELOG.md file is being removed without explanation in the PR description. While this may be intentional (perhaps switching to GitHub Releases or another approach), the removal should be explicitly mentioned and justified in the PR description.
Note that the .goreleaser.yml configuration has changelog generation disabled, so if CHANGELOG.md is removed and no alternative is set up, there will be no changelog for future releases.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
update readme
Type of Change
Checklist
make test)make format)Testing
Describe how you tested these changes:
Screenshots/Output
If applicable, add screenshots or command output to help explain your changes.