New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Include guidance on adding new operators in Contributing.md #1416
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 to 2 sentences
sounds inappropriate... A clear definition is wanted. I think we should add the steps to generate/update Operators.md and TestCoverage.md.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@houseroad Yes, the description in Operators.md had better be clearly defined. I was referring to the opening comment in the PR, for which people could be a little more brief than what they say in Operators.md, but not so brief as PR 1089 "This PR will add a new operator "expand" to onnx", as it becomes tedious to dig into the raw files across dozens of PR's when trying to get a holistic view of what new operators we need to support during new releases. Maybe people should just copy the description from their Operators.md into the first PR comment? Regarding regenerating Operators.md and TestCoverage.md, I'd support someone adding those details who is familiar with the process (as I don't know them).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
e.g. "Operator description - a clear description of what the operator does and how it works, both in Operators.md and the opening PR comment, so that readers can understand a summary even before reviewing the files changed (you can just copy the summary from Operators.md into the PR comment)."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fdwr I agree with your intent of having a smaller description in the opening comment of the PR and full detailed description in Operators.md doc. I think we just need to spell that out in the section above more clearly.