chore: replace generic emails with GitHub references#24
Conversation
Replace generic @netresearch.de email addresses with GitHub-native mechanisms (Issues, Security Advisories, repository URLs). - Remove email from package metadata (composer.json, ext_emconf.php) - Add support/issues URLs to package metadata - Replace security contact with GitHub Security Advisories - Replace support/contact emails with GitHub Issues links - Remove email from PHP docblock @author tags - Use OCI labels in Dockerfiles
Summary of ChangesHello @CybotTM, 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 modernizes the project's contact and support information by transitioning from generic email addresses to GitHub-native references. The changes update package metadata to direct users to GitHub for support issues and source code, aligning with best practices for public repositories to reduce spam and streamline communication channels. Highlights
Changelog
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
There was a problem hiding this comment.
Code Review
The changes successfully transition the project's metadata from generic email contacts to GitHub-native references. This improves security by using GitHub's private vulnerability reporting and reduces spam. I have provided suggestions to improve consistency between the manifest files and to enhance the discoverability of documentation.
| "author": { | ||
| "name": "Netresearch DTT GmbH", | ||
| "email": "info@netresearch.de" | ||
| "url": "https://github.com/netresearch/github-project-skill" |
There was a problem hiding this comment.
The author URL here points to the repository, while in composer.json it points to the company website. For consistency in how the author entity is referenced across manifests, consider using the same URL.
| "url": "https://github.com/netresearch/github-project-skill" | |
| "url": "https://www.netresearch.de/" |
| ] | ||
| ], | ||
| "support": { | ||
| "issues": "https://github.com/netresearch/github-project-skill/issues" |
There was a problem hiding this comment.
| "issues": "https://github.com/netresearch/github-project-skill/issues", | ||
| "source": "https://github.com/netresearch/github-project-skill" |
There was a problem hiding this comment.
Including a docs link in the support section improves discoverability of the project's documentation (e.g., the SKILL.md file).
"issues": "https://github.com/netresearch/github-project-skill/issues",
"source": "https://github.com/netresearch/github-project-skill",
"docs": "https://github.com/netresearch/github-project-skill"
Summary
@netresearch.deemail addresses with GitHub-native referencessupportsection to package metadata with Issues/Source URLsMotivation
Generic email addresses in public repositories attract spam and create maintenance overhead. GitHub provides better mechanisms for each use case:
Test plan