docs: clarify relationship between this repo and the Seed Project#1019
docs: clarify relationship between this repo and the Seed Project#1019sambilbow wants to merge 5 commits intoterraform-google-modules:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @sambilbow, 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 documentation by providing clearer guidance on the "Seed Project" concept. It addresses previous ambiguities by adding a practical Highlights
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
This pull request aims to clarify the concept of a 'Seed Project' by updating the documentation. The changes in README.md make it clearer that the seed project must already exist. The addition of a minimal working example in docs/GLOSSARY.md is a great idea. I've provided a couple of suggestions to improve the clarity and correctness of the documentation changes. Specifically, I've pointed out a grammatical error and a non-functional code example that should be corrected to avoid confusion for users.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days |
Hey! I struggled somewhat with the lack of documentation around what is referred to once in the README as a Seed Project.
It is not elaborated on in the README whether or not creating the Seed Project is part of this repo's scope (though to someone with an understanding / experience of bootstrapping I'm sure this is obvious).
I think the documentation would be clearer if it: