Skip to content

Consider adding instructions in CONTRIBUTING.md about submitting untested code #8104

@mhucka

Description

@mhucka

To head off some patterns we've seen recently, it may be worth adding some additional instructions to CONTRIBUTING.md. Some topics to write about:

  • Using the CI pipeline to test code rather than testing locally. Some people submit PRs with untested code with the expectation that the CI workflow will alert them to problems, and they then iterate on changes repeatedly instead of performing local testing. This is a waste of compute resources because the CI pipelines run more than is usually needed for testing during code development.

  • Using AIs to generate entire issue descriptions, pull request descriptions, or comments. It is one thing to use a tool to help (e.g., as a proof-reader, or a writing aid when one's native language is not English); it is another to just dump LLM output into the text box. The latter disrespects the human maintainers, usually wastes their time, and gives no indication that there is a human on the other side.

Metadata

Metadata

Assignees

Labels

area/docskind/feature-requestDescribes new functionalitypriority/before-1.7Finish before the Cirq 1.7 releasetriage/acceptedA consensus emerged that this bug report, feature request, or other action should be worked on

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions