Add CONTRIBUTING.md #293
Merged
Add CONTRIBUTING.md #293
Conversation
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
|
The documentation is not available anymore as the PR was closed or merged. |
lvwerra
reviewed
Sep 21, 2022
There was a problem hiding this comment.
Thanks @mathemakitten, looks great! Just one comment about community/canonical metrics.
CONTRIBUTING.md
Outdated
| less than 30s; | ||
| * Provide the *full* traceback if an exception is raised. | ||
|
|
||
| ### Do you want to implement a new metric? |
There was a problem hiding this comment.
I think we should probably explain a bit the difference between canonical and community metric here since it is cause for confusion sometimes.
- Canonical: well established metrics
- Community: new or custom metrics
Similarly we could state above (did you find a bug) that if it's a community metric one can create a PR/issue right on the repository.
There was a problem hiding this comment.
Good call, please see changes :)
Co-authored-by: Leandro von Werra <lvwerra@users.noreply.github.com>
…valuate into hn-contributing-md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adapted from the
transformersanddatasetsversions; the main changes are in theDo you want to implement a new metric?section which is specific toevaluate.