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: update template-development.md #933

Merged
merged 6 commits into from
Jun 27, 2023
Merged

Conversation

nickshoe
Copy link
Contributor

Description

  • Fix package.json "supportedProtocols" examples (use a list of values instead of a string)
  • Restate the "template" folder explanation

Fix "supportedProtocols" example + Restate the "template" folder explanation
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@sonarcloud
Copy link

sonarcloud bot commented Apr 11, 2023

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

@nickshoe nickshoe changed the title docs: Update template-development.md docs: update template-development.md Apr 11, 2023
@Florence-Njeri
Copy link
Collaborator

Hi @nickshoe. Thank you for helping make the Generator documentation better. What issue is this PR addressing?

@nickshoe
Copy link
Contributor Author

nickshoe commented Apr 11, 2023

Hi @Florence-Njeri there is not a tracked issue, the PR addresses a problem in the package.json example and (hopefully) clarifies the purpouse of the template folder and its content.

@nickshoe
Copy link
Contributor Author

Hey @Florence-Njeri, let me know if I shall change something or create an issue for this PR. ;)

@derberg
Copy link
Member

derberg commented May 10, 2023

@Florence-Njeri fyi we do not make it mandatory for people to create issue first if the PR has a small scope. In this case of supportedProtocols the fix makes total sense. Regarding wording change for other parts, I leave it up to you to decide

@Florence-Njeri
Copy link
Collaborator

@Florence-Njeri fyi we do not make it mandatory for people to create issue first if the PR has a small scope. In this case of supportedProtocols the fix makes total sense. Regarding wording change for other parts, I leave it up to you to decide

Makes sense

@derberg
Copy link
Member

derberg commented May 22, 2023

@Florence-Njeri can you have a look?

@derberg
Copy link
Member

derberg commented Jun 21, 2023

@Florence-Njeri @pratik2315 folks we need your approval to merge

@Florence-Njeri
Copy link
Collaborator

@derberg @nickshoe I left one suggestion on the file, please take a look and accept if it looks good

@sonarcloud
Copy link

sonarcloud bot commented Jun 26, 2023

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
0.0% 0.0% Duplication

@derberg
Copy link
Member

derberg commented Jun 27, 2023

/rtm

@asyncapi-bot asyncapi-bot merged commit 9d29c69 into asyncapi:master Jun 27, 2023
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 1.10.10 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

4 participants