Skip to content
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

Merged

Conversation

char0n
Copy link
Collaborator

@char0n char0n commented Jun 27, 2022

Some fixed fields description have dots and some don't. This PR provides remediation and introduces a little bit more consistency.

Copy link
Member

@smoya smoya left a 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:.

@char0n
Copy link
Collaborator Author

char0n commented Jun 27, 2022

LGTM, however I think docs: commit prefix fits better than refactor:.

Sure, can be address by squash and merge workflow, or do you want me to force push a new amended commit msg?

@smoya
Copy link
Member

smoya commented Jun 27, 2022

LGTM, however I think docs: commit prefix fits better than refactor:.

Sure, can be address by squash and merge workflow, or do you want me to force push a new amended commit msg?

You just need to change it in the PR title. The PR title is used as the commit message when squashing.

@char0n char0n changed the title refactor(asyncapi.md): make sentence dots consitent docs(asyncapi.md): end OAuth Flows Object field descriptions always with dot Jun 27, 2022
@char0n
Copy link
Collaborator Author

char0n commented Jun 27, 2022

Done.

fmvilas
fmvilas previously approved these changes Jul 4, 2022
Copy link
Member

@fmvilas fmvilas left a 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:?

@derberg
Copy link
Member

derberg commented Jul 4, 2022

it should be just docs: and then it will automatically be refreshed on the website

this is editorial change, why not against master? it doesn't change the meaning

@char0n
Copy link
Collaborator Author

char0n commented Jul 4, 2022

this is editorial change, why not against master? it doesn't change the meaning

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.

@derberg
Copy link
Member

derberg commented Jul 4, 2022

@char0n no worries, happy to explain.

The only difference is that if you make an editorial change against next-major, then the change will wait until the next release window to get released. And if the change is introduced against master, and with docs: prefix, then we update it also automatically on asyncapi.com

so yeah, editorial changes is a key here, because if it is more, then yeah, should not go to master

@char0n char0n changed the base branch from next-spec to master July 4, 2022 14:31
@char0n char0n dismissed fmvilas’s stale review July 4, 2022 14:31

The base branch was changed.

@char0n char0n force-pushed the char0n/consistent-dots-oauth-flows branch from 7c9b9ce to 8f6e2df Compare July 4, 2022 14:34
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jul 4, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@char0n
Copy link
Collaborator Author

char0n commented Jul 4, 2022

Base branch changed, thanks for explanation.

@derberg derberg changed the title docs(asyncapi.md): end OAuth Flows Object field descriptions always with dot docs: end OAuth Flows Object field descriptions always with dot Jul 4, 2022
@derberg
Copy link
Member

derberg commented Jul 4, 2022

/rtm

@asyncapi-bot asyncapi-bot merged commit 9196699 into asyncapi:master Jul 4, 2022
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.5.0-next-major-spec.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@fmvilas
Copy link
Member

fmvilas commented Sep 22, 2022

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 3.0.0-next-major-spec.1. There's a notice in the release. Apologies for the noise.

@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 2.5.0-next-spec.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@derberg
Copy link
Member

derberg commented Jan 31, 2023

Recent comments about the release from the bot were added by mistake. More details in #899

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants