-
Notifications
You must be signed in to change notification settings - Fork 3
Two patches #82
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Two patches #82
Conversation
Remove verbose sections and redundant explanations. Consolidate the table of contents into a concise 'What's Here' section. Trim the Renovate documentation to essential information while keeping the config example for maintainers. Assisted-by: OpenCode (Claude Sonnet 4) Signed-off-by: Colin Walters <walters@verbum.org>
Document the standard steps for onboarding new repositories: - Adding the maintainers team with Maintain permission - Configuring Renovate to inherit the shared config - Post-setup verification checklist Assisted-by: OpenCode (Claude Sonnet 4) Signed-off-by: Colin Walters <walters@verbum.org>
Summary of ChangesHello @cgwalters, 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 enhances the project's documentation by simplifying the main Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces two valuable documentation improvements. The README.md is significantly simplified and consolidated, making it much easier to read and navigate. The new Standard Operating Procedure for setting up new repositories is a great addition that will help standardize onboarding. My review found a couple of broken links in the new documentation, for which I've provided suggestions to fix them. Overall, these are excellent changes.
| ### Manual Runs | ||
|
|
||
| --- | ||
| Trigger Renovate manually from the [Actions tab](../../actions/workflows/renovate.yml) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The relative link to the Actions tab is incorrect. A relative link from the root README.md like ../../... will not resolve correctly. It's better to use a full URL to the workflow's Action page, which is more stable and user-friendly. This also makes it consistent with the link in the new SOP-new-repository.md document.
| Trigger Renovate manually from the [Actions tab](../../actions/workflows/renovate.yml) | |
| Trigger Renovate manually from the [Actions tab](https://github.com/bootc-dev/infra/actions/workflows/renovate.yml) |
|
|
||
| If synced workflow files are used (rebase.yml, openssf-scorecard.yml, etc.), | ||
| add the repository to the `ignorePaths` rule in | ||
| [renovate-shared-config.json](renovate-shared-config.json) to avoid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The relative link to renovate-shared-config.json is broken. Since this document is in the docs/ directory, the link should point one level up to the repository root where the file is located.
| [renovate-shared-config.json](renovate-shared-config.json) to avoid | |
| [renovate-shared-config.json](../renovate-shared-config.json) to avoid |
README: Simplify and consolidate content
Remove verbose sections and redundant explanations. Consolidate the
table of contents into a concise 'What's Here' section. Trim the
Renovate documentation to essential information while keeping the
config example for maintainers.
Assisted-by: OpenCode (Claude Sonnet 4)
Signed-off-by: Colin Walters walters@verbum.org
docs: Add SOP for new repository setup
Document the standard steps for onboarding new repositories:
Assisted-by: OpenCode (Claude Sonnet 4)
Signed-off-by: Colin Walters walters@verbum.org