Make various very small edits and tiny updates (#958)

Author: mhucka

.editorconfig

@@ -12,18 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: define basic code editor style parameters for this project.
-
-# Many IDEs & editors read .editorconfig files, either natively or via plugins.
-# We mostly follow Google's style guides (https://google.github.io/styleguide/)
-# with only a few deviations for line length and indentation in some files.
-
 root = true
 
-# IMPORTANT: some of the other config files (.markdownlintrc, .jsonlintrc.yaml,
-# pyproject.toml, etc.) also have settings for indent and line length. When
-# making changes to this file, make sure to update the other files to match.
+# We mostly follow Google style guides (https://google.github.io/styleguide/)
+# with only a few deviations for line length and indentation in some files.
 
+# IMPORTANT: some of the other config files (.clang-format, etc.) also have
+# the same settings and need to be updated if changes are made to this file.
 [*]
 charset = utf-8
 indent_style = space
@@ -32,12 +27,15 @@ spelling_language = en-US
 trim_trailing_whitespace = true
 max_line_length = 80
 
-[{BUILD,*.BUILD,*.bzl,*.bazel,.bazelrc}]
+[{BUILD,*.BUILD,*.bzl,*.bazel,.bazelrc,WORKSPACE}]
 indent_size = 4
 
 [{CMakeLists.txt,*.cmake}]
 indent_size = 4
 
+[Dockerfile]
+indent_size = 4
+
 [{Makefile,makefile,*.mk}]
 indent_style = tab
 indent_size = 4
@@ -59,5 +57,5 @@ indent_size = 4
 [*.toml]
 indent_size = 2
 
-[{*.yaml,*.yml}]
+[{*.yaml,*.yml,*.cff}]
 indent_size = 2

.gemini/styleguide.md

@@ -28,7 +28,9 @@ separate subsections for Python, C++, and other file types below.
 
 *   Tests must be independent and must not rely on the state of other tests.
     Setup and teardown functions should be used to create a clean environment
-    for each test run.
+    for each test run. External dependencies (e.g., databases, network
+    services, file system) must be mocked to ensure the test is isolated to the
+    unit under test.
 
 *   Make sure to cover edge cases: write tests for invalid inputs, null values,
     empty arrays, zero values, and off-by-one errors.
@@ -39,8 +41,8 @@ separate subsections for Python, C++, and other file types below.
 
 ### Overall code format conventions
 
-This project generally follows Google coding conventions, with a few changes.
-The following Google style guides are the starting points:
+Quantum AI projects generally follows Google coding conventions, with a few
+changes. The following Google style guides are the starting points:
 
 *   [Google C++ Style Guide](
     https://google.github.io/styleguide/cppguide.html)
@@ -54,12 +56,13 @@ The following Google style guides are the starting points:
 *   [Google Shell Style Guide](
     https://google.github.io/styleguide/shellguide.html)
 
-To learn the conventions for line length, indentation, and other style
-characteristics, please inspect the following configuration files (if present at
-the top level of this project repository):
+To learn this project's conventions for line length, indentation, and other
+details of coding style, please inspect the following configuration files (if
+present at the top level of this project repository):
 
-*   [`.editorconfig`](../.editorconfig) for basic code editor configuration for
-    indentation and line length.
+*   [`.editorconfig`](../.editorconfig) for basic code editor configuration
+    (e.g., indentation and line length) specified using the
+    [EditorConfig](https://editorconfig.org/) format.
 
 *   [`.clang-format`](../.clang-format) for C++ code and also protobuf (Protocol
     Buffers) data structure definitions.
@@ -160,7 +163,7 @@ naming, we can reduce cognitive load on human users and developers.
 
 ###  Docstrings and documentation
 
-This project uses [Google style doc strings](
+For Python code, this project uses [Google style doc strings](
 http://google.github.io/styleguide/pyguide.html#381-docstrings) with a Markdown
 flavor and support for LaTeX. Docstrings use tripe double quotes, and the first
 line should be a concise one-line summary of the function or object.

.github/workflows/ci.yaml

@@ -14,10 +14,10 @@
 
 # yamllint disable rule:line-length
 
-name: Continuous integration
+name: CI
 run-name: >-
-  Run CI checks for ${{github.event_name}} on ${{github.ref_name}}
-  by @${{github.actor}}
+  Run continuous integration checks for ${{github.event_name}} on
+  ${{github.ref_name}} by @${{github.actor}}
 
 on:
   push:

.hadolint.yaml

@@ -12,14 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: configure the Dockerfile linter "hadolint" for this project.
-# Info about options can be found at https://github.com/hadolint/hadolint/.
-# Rule/error numbers are described at https://github.com/hadolint/hadolint/wiki
+# See https://github.com/hadolint/hadolint/ for info about config options.
+# IMPORTANT: if you change values here, update .editorconfig to match.
 
 format: tty
 no-color: false
 no-fail: false
 failure-threshold: error
+
+# Rule/error numbers are described at https://github.com/hadolint/hadolint/wiki
 ignored:
   # Multiple consecutive RUN stmts are usually deliberate. Don't flag that.
   - DL3059

.jsonlintrc.yaml

@@ -12,7 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: configure https://github.com/prantlf/jsonlint for this project.
+# The variant of `jsonlint` we use is (https://github.com/prantlf/jsonlint).
+# IMPORTANT: if you change values here, update .editorconfig to match.
 
 comments: false
 compact: true

.markdownlintrc

@@ -13,15 +13,15 @@
   // See the License for the specific language governing permissions and
   // limitations under the License.
 
-  // Summary: configure markdownlint for this project.
-  //
-  // Note: there are multiple programs programs named "markdownlint". We use
-  // https://github.com/igorshubovych/markdownlint-cli/, which is the one you
-  // get with "brew install markdownlint" on MacOS.
-  //
+  // IMPORTANT: if you change values here, update .editorconfig to match.
+
   // These settings try to stay close to the Google Markdown Style as
   // described at https://google.github.io/styleguide/docguide/style.html
   // with very few differences.
+
+  // Note: there are multiple programs programs named "markdownlint". We use
+  // https://github.com/igorshubovych/markdownlint-cli/, which is the one you
+  // get with "brew install markdownlint" on MacOS.
   //
   // For a list of possible configuration options, see the following page:
   // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md

.yamlfmt.yaml

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: configure yamlfmt for this project.
-# See https://github.com/google/yamlfmt for info about options.
+# See https://github.com/google/yamlfmt/ for info about configuration options.
+# IMPORTANT: if you change values here, update .editorconfig to match.
 
 # Read .gitignore for paths to exclude.
 gitignore_excludes: true

.yamllint.yaml

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Summary: configure yamllint for this project.
 # See https://yamllint.readthedocs.io/ for info about configuration options.
+# IMPORTANT: if you change values here, update .editorconfig to match.
 
 rules:
   line-length:

setup.py

@@ -149,7 +149,7 @@ def build_extension(self, ext):
     url="https://github.com/quantumlib/qsim",
     author="The qsim/qsimh Developers",
     author_email="[email protected]",
-    maintainer="Google Quantum AI open-source maintainers",
+    maintainer="Google Quantum AI",
     maintainer_email="[email protected]",
     python_requires=">=3.10.0",
     install_requires=requirements,