feat(new-rule): ibm-operation-summary-length #663
Merged
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
|
|
Adds a rule that verifies operation summaries are 80 characters or less in length, based on the summary writing guidance in the API Handbook. Signed-off-by: Dustin Popp <dpopp07@gmail.com>
pyrooka
approved these changes
May 9, 2024
There was a problem hiding this comment.
The change looks good altogether!
Re: the merging question. I think it's fine to leave this as a separate rule, but if we decide to merge it, I'd choose the ibm-operation-summary. I think it makes a bit more sense to have the null || len(summary) > 80 logic in the same rule. Also, the sentence style can be changed in the future, by adding new criteria, for example "start with capital letter".
padamstx
approved these changes
May 9, 2024
ibm-devx-sdk
pushed a commit
that referenced
this pull request
May 9, 2024
# @ibm-cloud/openapi-ruleset [1.16.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@1.15.9...@ibm-cloud/openapi-ruleset@1.16.0) (2024-05-09) ### Features * **new-rule:** ibm-operation-summary-length ([#663](#663)) ([901cc1a](901cc1a))
|
🎉 This PR is included in version 1.16.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.17.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
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.
PR summary
Adds a rule that verifies operation summaries are 80 characters or less in length, based on the summary writing guidance in the API Handbook.
A question for the PR reviewers. We already have these existing rules:
Should this check be merged into one of the existing rules or does it belong as its own rule? The granularity is nice for configuration but it might be confusing to have too many rules doing such similar things. What do y'all think?
PR Checklist
General checklist
Please make sure that your PR fulfills the following requirements:
Checklist for adding a new validation rule: