Add more information to CONTRIBUTING.md#1041
Add more information to CONTRIBUTING.md#1041mhucka wants to merge 16 commits intotensorflow:masterfrom
CONTRIBUTING.md#1041Conversation
This adds much more information about development practices and expectations.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly expands and restructures the CONTRIBUTING.md file to provide comprehensive guidelines for TensorFlow Quantum, covering legal requirements, code base conventions, and the development process. Review feedback suggests fixing broken Markdown link syntax caused by line breaks, clarifying the specific license and boilerplate required for new source files, and improving the formatting of Git commit message examples. Additionally, it is recommended to remove the -march=native flag from the build instructions to ensure the resulting binaries remain portable across different CPU architectures.
mhucka
changed the title
CONTRIBUTING.md
It's a bit too negative.
Based on feedback from Pablo, I added some text to request more information in people's PRs.
Having trouble figuring out how to make markdownlint-cli easily installable for people.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request significantly expands the CONTRIBUTING.md file, providing detailed instructions on environment setup, coding standards, and the development workflow for TensorFlow Quantum. The review feedback focuses on enhancing documentation consistency and technical accuracy, specifically recommending standardized link formats, the use of backticks for commands and directory paths, and the correction of Bazel terminology in command templates.
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>
2 participants
This overhauls
CONTRIBUTING.mdto provide more detail about all aspects of the contribution processes for TensorFlow Quantum. I avoided repeating some information by pointing to existing documentation for TensorFlow Quantum and TensorFlow, and tried to balance conciseness with detail. To make the source.mdfile (hopefully) more readable, I made use of Markdown reference-style syntax for links when it would simplify source formatting.