docs: add generator onboarding webinar to contributing guides #1753
Conversation
Kartikayy007
requested review from
Florence-Njeri,
asyncapi-bot-eve and
derberg
as code owners
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
What reviewer looks at during PR reviewThe following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.
|
WalkthroughAdded onboarding webinar reference to CONTRIBUTING.md and a new "Before You Begin - New Contributor Onboarding" section in Development.md; expanded onboarding content and reordered/renumbered contribution tips; performed minor punctuation and wording normalizations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
🔇 Additional comments (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
CONTRIBUTING.md
Outdated
| 7. Keep **PRs small and focused** – A small PR with a well-defined scope is easier to review and merge. Avoid bundling multiple changes into one PR. | ||
| 8. Collaborate with Other Contributors – If someone else has already raised an issue and you are interested in contributing to it, please communicate with them and collaborate instead of raising a separate PR independently. Working together leads to better contributions and avoids duplication of efforts. Open source is driven by **collaboration, not competition**. | ||
| 9. **Respond to Maintainer Reviews Promptly** - If a maintainer requests changes or provides feedback on your PR, please try to address them within **7 days**. If you’re unable to respond by then, the PR may be closed. Contributors are always welcome to open a new PR once they’re ready to continue. | ||
| 2. **Watch the Onboarding Webinar** - Before diving into code, watch our [Generator onboarding webinar](https://www.youtube.com/watch?v=Mkd7FgKOMNE) to understand the architecture and design decisions. This 45-minute webinar covers AsyncAPI fundamentals, the Generator's evolution, template development, and live demonstrations. See the [Development Guide](Development.md#before-you-begin---new-contributor-onboarding) for more details on what you'll learn. |
There was a problem hiding this comment.
you make a false promise 😄 it is definitely not 45min video - unfortunately 😄
There was a problem hiding this comment.
See the Development Guide for more details on what you'll learn.
I'm actually surprised we were not referencing development guide so far.
But please changes it, make it separate step - the last step please, and in general link to development guide, not webinar
There was a problem hiding this comment.
Watch the Onboarding Webinar - Before diving into code, watch our Generator onboarding webinar to understand the architecture and design decisions.
this part was good, I did not ask to remove it
There was a problem hiding this comment.
I need your guidance here I see the part is already there im a bit confused and please review ive done all other changes mentioned including to have to the point PR description, please guide me if im doing something wrong
Development.md
Outdated
|
|
||
| This webinar provides essential context about the Generator's architecture, design decisions, and development workflow. Watching it will make the rest of this development guide much clearer and help you contribute more effectively. | ||
|
|
||
| --- |
|
Ready for another review @derberg |
|
@derberg, I finalised it please review |
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
I'm afraid you're not reading my instructions
|
I apologize, @derberg I misunderstood what you said earlier. I have now deleted the section. I appreciate your patience. |
|
please carefully always go through all comments and read them carefully to limit ping-pong to minimum also familiarize with #1753 (comment) - which means please update your PR description to be more accurate. Please use your own words and do not dump such a large AI description for such a trivial PR |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
Development.md(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Test generator as dependency with Node 18
- GitHub Check: Acceptance tests for generated templates
- GitHub Check: Test generator as dependency with Node 20
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - macos-latest
- GitHub Check: Test NodeJS PR - ubuntu-latest
🔇 Additional comments (3)
Development.md (3)
5-23: Verify webinar URL, title, and learning outcomes accuracy.The new onboarding section is well-structured and positioned appropriately. However, before merge, please verify:
- The webinar URL (line 9) and full title match the actual YouTube video.
- The learning outcomes (lines 13–20) accurately represent what contributors will learn from the webinar (e.g., "shift from Nunjucks to React render engine", "component-based template development", etc.).
- The "strongly recommend watching first" framing (line 7) is appropriate—i.e., whether new contributors should complete this webinar before proceeding with the rest of the Development guide.
Also, confirm that this section aligns with the "Watch the Onboarding Webinar" tip added to CONTRIBUTING.md (mentioned in the summary).
203-203: Clarify intent of troubleshooting note formatting change.The troubleshooting section's closing line was reformatted from list-item to plain text. Past review feedback indicated something should have been removed ("still there"). Please confirm this change addresses that concern, or if there is still unnecessary content that needs to be removed.
5-23: Verify learning outcomes match webinar content.The onboarding section is well-structured and appropriately positioned. However, please verify that all eight learning outcomes (lines 13–20) accurately reflect what contributors will learn from the webinar. In particular, confirm:
- That the outcomes like "shift from Nunjucks to React render engine" and "component-based template development" are actually covered in the webinar.
- That the outcome descriptions are precise and match the webinar's actual content depth.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: Test generator as dependency with Node 20
- GitHub Check: Test generator as dependency with Node 18
- GitHub Check: Acceptance tests for generated templates
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Test NodeJS PR - macos-latest
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (2)
CONTRIBUTING.md (2)
33-43: Webinar placement and Development Guide link follow reviewer feedback.The structure correctly positions the onboarding webinar as step 1 and the Development Guide reference as the final step (11) in Guidelines for New Contributors, aligning with derberg's previous requests.
1-25: Verify PR description clarity and completeness.Per derberg's previous feedback, ensure the PR description is written clearly in your own words and comprehensively explains the changes (not AI-generated or copied verbatim). The description should reference issue #1736 (which is mentioned in PR metadata) and summarize what was added and why.
Can you confirm the PR description has been updated to clearly explain the issue being resolved and the changes made, and that it references "Resolves #1736"?
|
4 participants
Description
Adds the AsyncAPI Generator onboarding webinar as a contribution tip to help new contributors understand the Generator's architecture before diving into code.
Changes:
Related issue(s)
Resolves #1736
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.