docs: improve documentation#222
Merged
Merged
Conversation
…inting command in `CONTRIBUTING.md`
… contributing guidelines
IronTony
approved these changes
Mar 17, 2026
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.
Description of Changes
This PR introduces several documentation and configuration improvements aimed at clarifying project structure, streamlining contribution processes, and enhancing issue and security management. The most significant updates include a comprehensive overhaul of the main
README.mdto better explain the monorepo structure and usage, new and improved issue and pull request templates, the addition of a dedicated security policy, and refinements to code ownership and dependency management.Documentation and Project Structure:
README.mdto clearly describe the monorepo structure, list all packages and examples, provide quick start and contribution instructions, and add a visual directory tree.packages/google-signin/README.md. Also added contribution guidelines to the package README. [1] [2]Repository Configuration and Templates:
.github/CODEOWNERSto clarify ownership patterns, add explicit owners for core, packages, examples, and CI/CD configuration, and ensure later matches take precedence..github/pull_request_template.mdto include affected package checkboxes, a breaking changes section, improved testing instructions, and a Conventional Commits checklist item. [1] [2] [3]Security and Contribution Process:
SECURITY.mddetailing how to report vulnerabilities, supported versions, response timelines, and in-scope areas for security issues.CONTRIBUTING.mdto reflect the use ofpnpm -r lintinstead ofyarn lintfor linting.Dependency and Automation Management:
.github/dependabot.ymlto include thepackages/google-signindirectory for dependency updates.These changes collectively improve the developer experience, clarify contribution and support processes, and help maintain code and documentation quality across the project.
How to Test
Vitest) and build steps pass successfully on this PR.pnpm install(or equivalent).pnpm devor equivalent) for the library or examples to ensure Vite starts correctly.pnpm buildor equivalent) to ensure it completes successfully.Checklist
Notes for Reviewers