Add more information to CONTRIBUTING.md#1041
Open
mhucka wants to merge 6 commits intotensorflow:masterfrom
Open
Add more information to CONTRIBUTING.md#1041mhucka wants to merge 6 commits intotensorflow:masterfrom
CONTRIBUTING.md#1041mhucka wants to merge 6 commits intotensorflow:masterfrom
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.