docs(community): add content to Where to Contribute page #4775
Conversation
me-pradeep
requested review from
TRohit20,
asyncapi-bot-eve and
thulieblack
as code owners
📝 WalkthroughWalkthroughReplaces the placeholder "under construction" page with a comprehensive "Where to Contribute" onboarding guide covering Documentation, Code, Testing and Quality, Design and User Experience, Community and Support, and How to Get Started. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4775 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 798 798
Branches 146 146
=========================================
Hits 798 798 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![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
🧹 Nitpick comments (1)
markdown/docs/community/000-onboarding/where-to-contribute.md (1)
6-77: Content structure and coverage look good.The document provides a comprehensive onboarding guide that addresses the PR objectives well. Each section clearly explains a contribution area with examples and relevant guidance. The organization is logical, and the tone is welcoming to new contributors.
Consider whether the "Testing and Quality," "Design and UX," and "Community and Support" sections should also list relevant repositories (similar to Documentation and Code sections) to provide more actionable guidance—this may improve discoverability for contributors interested in those areas.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/000-onboarding/where-to-contribute.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
markdown/docs/community/000-onboarding/where-to-contribute.md
23-23: Bare URL used
(MD034, no-bare-urls)
24-24: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - asyncapi-website
- GitHub Check: Header rules - asyncapi-website
- GitHub Check: Pages changed - asyncapi-website
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4775--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
markdown/docs/community/000-onboarding/where-to-contribute.md (1)
74-79: Enhance "How to Get Started" with Slack workspace link.Line 79 references joining the "AsyncAPI Slack workspace" but doesn't provide a link or joining instructions. Since this section guides first-time contributors to take action, include a direct link or reference to where contributors can access the Slack workspace (e.g., community guidelines page, main README, or invite URL) to make the onboarding flow more seamless.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/community/000-onboarding/where-to-contribute.md
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-01-19T04:51:41.255Z
Learnt from: anshgoyalevil
Repo: asyncapi/website PR: 3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Applied to files:
markdown/docs/community/000-onboarding/where-to-contribute.md
📚 Learning: 2024-11-13T20:34:18.998Z
Learnt from: bandantonio
Repo: asyncapi/website PR: 3393
File: markdown/blog/2024-Q1-docs-report.md:10-12
Timestamp: 2024-11-13T20:34:18.998Z
Learning: In the markdown files for the AsyncAPI website, avatar image paths should be referenced without the `public` prefix (e.g., use `/img/avatars/...` instead of `/public/img/avatars/...`).
Applied to files:
markdown/docs/community/000-onboarding/where-to-contribute.md
📚 Learning: 2025-07-19T20:58:34.040Z
Learnt from: bandantonio
Repo: asyncapi/website PR: 4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
Applied to files:
markdown/docs/community/000-onboarding/where-to-contribute.md
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test NodeJS PR - windows-latest
🔇 Additional comments (1)
markdown/docs/community/000-onboarding/where-to-contribute.md (1)
1-79: Strong onboarding content addition.The documentation comprehensively addresses all five contribution areas (documentation, code, testing, design, community support) and provides clear entry points for new contributors. The past bare URL issue has been resolved with proper markdown link formatting throughout.
|
hello @me-pradeep i would suggest go through contributing guide, AsyncAPI follows a proposal-first approach |
|
@sammy200-ui Hey bro, I’ve already read the contribution guidelines. As per a message from one of the maintainers on Slack, we can submit a PR without being assigned. |
|
@me-pradeep did you read what the maintainer said in that message ? , he said that to that specific issue only, but i do get your point about maintainer not assigning issues here , but you clearly didnt read the guide as you are imposing you did |
|
@sammy200-ui I’ve already looked at the diagram, but have you seen this comment? |
|
@me-pradeep i dont know what you are referring in that shot...i think you are confusing assign with approval , you are not to get assigned but you still need approval from the maintainers to begin work, in that shot the maintainer said to start working for the contributor , you are just putting some random screenshots here without getting the context , Not having assignments does not mean PRs can be opened without prior approval. Hoping confusion is clear from my side |
|
@sammy200-ui Yeah, but how will I know if I’m approved to make a PR? The only way I can see right now is by getting assigned to the issue. So here approval and assigning can bee seen as same. |
|
@me-pradeep wait for the approval , general time is about a week. maintainer will checkout your issue , then they suggest to go ahead and make a pr or not, hope that helps 😁 |
|
@me-pradeep Please refrain from raising a PR before the issue is approved by the maintainers. |
|
@princerajpoot20 okay sir I'll keep that in mind. |
4 participants
Closes #4774
This PR adds content to the "Where to Contribute" page in the
community onboarding section to help new contributors understand
different ways they can contribute to the AsyncAPI project.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.