Addressing review feedbacks for quickstart notebooks

google-gemini · MarkDaoust · Jun 4, 2024 · May 29, 2024 · May 31, 2024 · May 31, 2024
commit 363c50321284e77e8305ad82ea35daf2dd154d33
diff --git a/quickstarts/Audio.ipynb b/quickstarts/Audio.ipynb
diff --git a/quickstarts/Authentication.ipynb b/quickstarts/Authentication.ipynb
diff --git a/quickstarts/Authentication_with_OAuth.ipynb b/quickstarts/Authentication_with_OAuth.ipynb
diff --git a/quickstarts/Counting_Tokens.ipynb b/quickstarts/Counting_Tokens.ipynb
diff --git a/quickstarts/Embeddings.ipynb b/quickstarts/Embeddings.ipynb
diff --git a/quickstarts/File_API.ipynb b/quickstarts/File_API.ipynb
diff --git a/quickstarts/Function_calling.ipynb b/quickstarts/Function_calling.ipynb
diff --git a/quickstarts/Function_calling_config.ipynb b/quickstarts/Function_calling_config.ipynb
diff --git a/quickstarts/Gemini_Flash_Introduction.ipynb b/quickstarts/Gemini_Flash_Introduction.ipynb
diff --git a/quickstarts/Models.ipynb b/quickstarts/Models.ipynb
diff --git a/quickstarts/PDF_Files.ipynb b/quickstarts/PDF_Files.ipynb
diff --git a/quickstarts/Prompting.ipynb b/quickstarts/Prompting.ipynb
diff --git a/quickstarts/Safety.ipynb b/quickstarts/Safety.ipynb
diff --git a/quickstarts/Streaming.ipynb b/quickstarts/Streaming.ipynb
diff --git a/quickstarts/System_instructions.ipynb b/quickstarts/System_instructions.ipynb
diff --git a/quickstarts/Video.ipynb b/quickstarts/Video.ipynb
diff --git a/quickstarts/contrib.md b/quickstarts/contrib.md
@@ -0,0 +1,45 @@
+# Contributing to the Gemini API Cookbook
+
+We would love to accept your patches and contributions to the Gemini API Cookbook. We are excited that you are considering donating some of your time, and this guide will help us be respectful of that time.
+
+# Before you send anything
+
+## Sign our contributor agreement
+
+All contributions to this project must be accompanied by a [Contributor License Agreement](https://cla.developers.google.com/about) (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.
+
+If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.
+
+Visit [https://cla.developers.google.com/](https://cla.developers.google.com/) to see your current agreements or to sign a new one.
+
+## Style guides
+
+Before you start writing, take a look at the [technical writing style guide](https://developers.google.com/style). You don’t need to fully digest the whole document, but do read the [highlights](https://developers.google.com/style/highlights) so you can anticipate the most common feedback.
+
+Also check out the relevant [style guide](https://google.github.io/styleguide/) for the language you will be using. These apply strictly to raw code files (e.g. *.py, *.js), though code fragments in documentation (such as markdown files or notebooks) tend to favor readability over strict adherence.
+
+For Python notebooks (*.ipynb files), consider running `pyink` over your notebook. It is not required, but it will avoid style-related nits.
+
+# Making changes
+
+## Small fixes
+
+Small fixes, such as typos or bug fixes, can be submitted directly via a pull request.
+
+## Content submission
+
+Before you send a PR, or even write a single line, please file an [issue](https://github.com/google-gemini/cookbook/issues). There we can discuss the request and provide guidance about how to structure any content you write.
+
+Adding a new guide often involves lots of detailed reviews and we want to make sure that your idea is fully formed and has full support before you start writing anything. If you want to port an existing guide across (e.g. if you have a guide for Gemini on your own GitHub), feel free to link to it in the issue.
+
+## Things we consider
+
+When accepting a new guide, we want to balance a few aspects.
+* Originality - e.g. Is there another guide that does the same thing?
+* Pedagogy - e.g. Does this guide teach something useful? Specifically for a Gemini API feature?
+* Quality - e.g. Does this guide contain clear, descriptive prose? Is the code easy to understand?
+
+It is not crucial for a submission to be strong along all of these dimensions, but the stronger the better. Old submissions may be replaced in favor of newer submissions that exceed these properties.
+
+## Attribution
+If you have authored a new guide from scratch, you are welcome to include a byline at the top of the document with your name and GitHub username.