chore(*): add repository fields to repos - #217
Conversation
🦋 Changeset detectedLatest commit: 175e543 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
To view this pull requests documentation preview, visit the following URL: docs.page/invertase/tanstack-query-firebase~217 Documentation is deployed and generated using docs.page. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds repository metadata to package.json files for better package discovery and maintainability. The changes ensure that npm packages have proper repository information that helps users and tools identify the source code location.
- Add repository field to both React and Angular package.json files
- Standardize author information in the Angular package
- Document changes with a changeset for version tracking
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/react/package.json | Adds repository field with Git URL |
| packages/angular/package.json | Adds repository field and updates author from empty string to full object |
| .changeset/real-toes-shout.md | Documents the changes for version tracking |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @cabljac, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces metadata updates to the package.json files for the @tanstack-query-firebase/angular and @tanstack-query-firebase/react packages. It standardizes the author and repository fields, improving the discoverability and information available for these packages on registries like npm.
Highlights
- Package Metadata Enhancement: Updated package.json files for @tanstack-query-firebase/angular and @tanstack-query-firebase/react to include comprehensive author and repository information.
- Angular Package Update: Specifically, the @tanstack-query-firebase/angular package's package.json now includes detailed author information (name, email, URL) and a repository link.
- React Package Update: The @tanstack-query-firebase/react package's package.json has been updated to include the repository link.
- Changelog Entry: A new changeset file (.changeset/real-toes-shout.md) has been added to document this chore as a patch release for both affected packages.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds the author and repository fields to the package.json files for the angular and react packages. This is a valuable addition for package consumers. My review includes suggestions to enhance the repository field by specifying the package directory within the monorepo and using the standard .git suffix in the URL, which improves discoverability and tooling support.
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/invertase/tanstack-query-firebase" | ||
| }, |
There was a problem hiding this comment.
For monorepos, it's a good practice to specify the directory of the package within the repository. This helps tools like npm and other developers to locate the package source correctly. Also, it's conventional to use the .git suffix for the repository URL.
| "repository": { | |
| "type": "git", | |
| "url": "https://github.com/invertase/tanstack-query-firebase" | |
| }, | |
| "repository": { | |
| "type": "git", | |
| "url": "https://github.com/invertase/tanstack-query-firebase.git", | |
| "directory": "packages/angular" | |
| }, |
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/invertase/tanstack-query-firebase" | ||
| }, |
There was a problem hiding this comment.
For monorepos, it's a good practice to specify the directory of the package within the repository. This helps tools like npm and other developers to locate the package source correctly. Also, it's conventional to use the .git suffix for the repository URL.
| "repository": { | |
| "type": "git", | |
| "url": "https://github.com/invertase/tanstack-query-firebase" | |
| }, | |
| "repository": { | |
| "type": "git", | |
| "url": "https://github.com/invertase/tanstack-query-firebase.git", | |
| "directory": "packages/react" | |
| }, |
No description provided.