Add workflow for checking PR titles & descriptions

[mhucka]

This workflow adds very simple checks for minimum requirements: a title that has at least two words, and a description that is at least 10 characters long.

In the future, more checks could be added as additional jobs in this workflow. For example, we should also check for the presence of non-inclusive terms such as "blacklist".

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.63%. Comparing base (603755a) to head (a284677).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7991   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files        1110     1110           
  Lines       99752    99752           
=======================================
  Hits        99390    99390           
  Misses        362      362           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[pavoljuhas]

I am not sure this is worth the extra maintenance for the new workflow. More than a minimum length it is important for the PR titles and descriptions to be well suited as commit messages which they become because we use merge queue. It should be a part of the review process to ensure that they are in a good shape. Perhaps we should first do a quick maintainers' chat to settle on some good title/description standards if you feel that some of our past PRs could do better.

[mhucka]

I agree we should have a maintainers discussion about conventions! And also, I think we should update the written maintainers documentation. Independently of that, IMHO I think a workflow will save us time in the long run by reducing the number of times we have to write comments requesting people to add descriptions to their PRs.

To back up that claim, I checked the last 1000 PRs and here is a list of those that were merged despite having empty descriptions – some even by (ahem) the two of us. This is 51 PRs out of the last 1000 = approx. 5% of PRs.

• fix typo #7977
• Add corresponding serialization for TwoPulseFSimTag #7971
• Fix EngineProgram.get_circuit(_async) empty code detection #7850
• Ignore outputs from pytest-benchmark and pytest-profiling #7812
• Fix parent resource name used to call ListQuantumProcessorConfigs #7802
• Bump js-yaml from 4.1.0 to 4.1.1 in /cirq-web/cirq_web #7757
• Send connection keepalive pings once per minute to prevent stream termination while awaiting long-running jobs #7755
• Add @hoisinberg as owner of cirq-google #7703
• fix bug in idle moments gauge #7669
• Regenerate QuantumEngineService RPC client to include ListQuantumProcessorConfigs #7636
• Cite Cirq release 1.6.1 #7576
• Cite Cirq release 1.6.0 #7530
• Bump cirq version to 1.7.0 #7526
• Add AnalogDetuneCouplerOnly #7444
• Fix typo in notebook example #7426
• Support serializing sweeps with numpy values #7398
• Ignore typing PR for git blame. #7363
• Update cirq resolver to check sympy singletons with is instead of == #7279
• Cite Cirq release 1.5.0 #7263
• Bump cirq version to 1.6.0 #7261
• Remove debug printouts from the test #7202
• Add boolean support to cirq_google protos #7177
• Fix some typos on the engine documentation page #6890
• Create a transformer that cancels the effect of Z-phases #6837
• Add ability to pass tags to XEB and related methods #6836
• Support serialization of sweeps with tunits #6829
• Support "cu1", "cu3", and "crz" in QasmParser #6820
• Add custom_args to value equality of InternalGate" #6799
• Have stale bot apply status/stale label for both issues and PRs #6796
• Create a way to encode general functions #6788
• Parallel XEB: Add option to specify pairs #6787
• Support TUnits in circuit serialization #6781
• Add TypedUnits to the requirements of cirq-google #6773
• Add support for const sweep with None in cirq-google/cirq_google/api/v2/run_context.proto #6729
• Fix misspelled class name in cirq-core/cirq/transformers/noise_adding.py #6716
• Fix XEB error rate computation #6673
• Bump cirq version to 1.5.0 #6624
• Add Quantum Engine Support for InternalGate #6613
• Add a note about conda env to dev doc #6592
• Add a new gauge for SqrtCZ and support SqrtCZ† and fix and improve spin inversion gauge #6571
• Add convenience methods to create PhasedXZ gate from ZYZ decomposition #6569
• Add Quantum Engine support for cirq.CZPowGate #6562
• update parallel XEB notebook #6494
• Add a convenience method that runs both RB and XEB #6471
• Address NumPy and NotImplemented deprecation warnings #6465
• convert cliffords to xz in qubit characterization #6420
• convert SingleQubitCliffordGate to phasedXZ during serialization #6419
• fix small normalization bug #6404
• Fix common typos #6403
• Add parallel randomized benchmarking #6382
• Bump cirq version to 1.4.0 #6369

[mhucka]

@Pavol Regarding this, what do you think about making this workflow simply add a comment to the PR requesting the changes, instead of failing the CI workflow altogether?

[mhucka]

Closing this for now, pending a re-think.