-
-
Notifications
You must be signed in to change notification settings - Fork 280
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
docs: end OAuth Flows Object field descriptions always with dot #815
docs: end OAuth Flows Object field descriptions always with dot #815
Conversation
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.
LGTM, however I think docs:
commit prefix fits better than refactor:
.
Sure, can be address by |
You just need to change it in the PR title. The PR title is used as the commit message when squashing. |
Done. |
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.
Looks good to me too.
@derberg is our CI aware of things like docs(asyncapi.md):
in the PR title? Or should we just use docs:
or chore:
?
it should be just this is editorial change, why not against |
I'm not familiar with all the internal rules of the AsyncAPI org. My intention was to increase the quality of the spec and from time to time I'm reviewing main README file and CONTRIBUTING to find directional information about current processes. From these two documents I haven't found a guideline, against what to actually send a PR, so I've send it to the same branch I was asked to send it the last time. |
@char0n no worries, happy to explain. The only difference is that if you make an editorial change against so yeah, |
7c9b9ce
to
8f6e2df
Compare
Kudos, SonarCloud Quality Gate passed! |
Base branch changed, thanks for explanation. |
/rtm |
🎉 This PR is included in version 2.5.0-next-major-spec.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Forget about the last comment saying it was released in version 2.5.0-next-major-spec.1. I made a mistake and it created this version but it should actually be |
🎉 This PR is included in version 2.5.0-next-spec.5 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Recent comments about the release from the bot were added by mistake. More details in #899 |
Some fixed fields description have dots and some don't. This PR provides remediation and introduces a little bit more consistency.