fix: broken AsyncAPI contributing guidelines link (#4395) #4398

SanidhyaMadheshia · 2025-09-07T13:37:10Z

Description
fixed the broken contributing guidelines link on /docs/community/000-onboarding page
Related issue(s)
issue: #4395

now on clicking on contributing guidelines link

it goes to

Summary by CodeRabbit

Documentation
- Replaced a relative link with an absolute GitHub URL to the contributing guidelines.
- Converted the reference into a blockquote to improve readability.
- Ensures the onboarding guide links reliably and reads more clearly for new contributors; no functional product changes.

netlify · 2025-09-07T13:37:15Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`d88a6eb`
🔍 Latest deploy log	https://app.netlify.com/projects/asyncapi-website/deploys/68c999c927f8a90008c50bd3
😎 Deploy Preview	https://deploy-preview-4398--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-09-07T13:37:17Z

Walkthrough

Updated a documentation file by replacing a relative CONTRIBUTING link with an absolute GitHub URL and formatting the line as a blockquote. No code, API, or public entity changes.

Changes

Cohort / File(s)	Summary
Documentation tweak `markdown/docs/community/000-onboarding/index.md`	Replaced relative link (`../../CONTRIBUTING.md`) with absolute URL (`https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md`) and prefixed the line with a blockquote (`>`).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

ready-to-merge

Suggested reviewers

thulieblack
TRohit20
CBID2
asyncapi-bot-eve
sambhavgupta0705
bandantonio

Poem

I hop through docs with a twitch and a wink,
Swapping small paths for a GitHub link.
Quoted and tidy, I point the way,
To the CONTRIBUTING burrow where helpers stay.
Nibble, nudge — the guide's ready today! 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "fix: broken AsyncAPI contributing guidelines link (#4395)" clearly and concisely summarizes the primary change—repairing the contributing guidelines link in the onboarding documentation—and directly relates to the modifications in markdown/docs/community/000-onboarding/index.md. It is specific enough for a reviewer to understand the main intent without listing files or unrelated details.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9364f38 and d46a5e9.

📒 Files selected for processing (1)

markdown/docs/community/000-onboarding/index.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

markdown/docs/community/000-onboarding/index.md

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-09-07T13:39:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c716db8) to head (d88a6eb).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4398   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          778       778           
  Branches       144       144           
=========================================
  Hits           778       778

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

asyncapi-bot · 2025-09-07T13:40:59Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	43
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-4398--asyncapi-website.netlify.app/

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

markdown/docs/community/000-onboarding/index.md (1)
9-9: Prefer resilient link target and avoid blockquote styling

Good fix. Two small improvements:

Use GitHub’s branch-agnostic HEAD so the link survives branch renames.

Link to org-wide contributing guide (matches the “various ways you can contribute to the AsyncAPI Initiative” wording). Alternatively, keep the repo-specific guide but still switch to HEAD.

Apply:
- > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md).
+For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/.github/blob/HEAD/CONTRIBUTING.md).
If you want to keep it repo-specific, use: https://github.com/asyncapi/website/blob/HEAD/CONTRIBUTING.md

References: org-wide CONTRIBUTING exists, and the website repo also has its own CONTRIBUTING. (github.com)

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cf11f17 and a8978cc.

📒 Files selected for processing (1)

markdown/docs/community/000-onboarding/index.md (1 hunks)

bandantonio · 2025-09-07T19:39:40Z

markdown/docs/community/000-onboarding/index.md

 The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively. 

-> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md).
+> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md).


@thulieblack Since we're not publishing CONTRIBUTING.md, I'm wondering, which one should we use - from the website or community repo?

@thulieblack I highly recommend and would also love to work in making CONTRIBUTING.md publish in website only.
As it will give a better UX and UI which is eventually required for better communication.

Each repo has a different CONTRIBUTING.md file. The one that has the community repo is general, so it's best to use that one.

@SanidhyaMadheshia
update the link to https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md

SanidhyaMadheshia · 2025-09-08T13:46:19Z

@bandantonio can you please suggest me the changes I should do or the core area to consider that I am lacking.

bandantonio · 2025-09-08T15:53:40Z

@SanidhyaMadheshia what changes are you talking about?

SanidhyaMadheshia · 2025-09-08T19:37:49Z

@SanidhyaMadheshia what changes are you talking about?

I was asking if i should build a page dedicated to this CONTRIBUTING.md file in codebase . so that user can have a better ux.

bandantonio · 2025-09-08T19:52:08Z

You shouldn't

sambhavgupta0705 · 2025-09-14T10:33:00Z

@SanidhyaMadheshia
update the link to https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (1)

markdown/docs/community/000-onboarding/index.md (1)
9-9: Link should target the community repo CONTRIBUTING.md (per maintainer guidance).

Past review concluded to link the general CONTRIBUTING in asyncapi/community, not website. Update the URL accordingly. The file exists here. (github.com)

Apply this diff:
- > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md).
+ > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/HEAD/CONTRIBUTING.md).

🧹 Nitpick comments (1)

markdown/docs/community/000-onboarding/index.md (1)
9-9: Nit: Avoid blockquote styling unless intentional.

Keeps the page’s typographic rhythm consistent with surrounding paragraphs.

Optional diff:
- > For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/HEAD/CONTRIBUTING.md).
+ For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/HEAD/CONTRIBUTING.md).

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b423a5 and 9364f38.

📒 Files selected for processing (1)

markdown/docs/community/000-onboarding/index.md (1 hunks)

⏰ 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). (2)

GitHub Check: Test NodeJS PR - macos-13
GitHub Check: Test NodeJS PR - windows-latest

SanidhyaMadheshia · 2025-09-14T10:50:02Z

@SanidhyaMadheshia update the link to https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md

@sambhavgupta0705 done the update

SanidhyaMadheshia · 2025-09-16T17:24:05Z

@thulieblack is any other changes i have to do..?

thulieblack

thank you

thulieblack · 2025-09-17T09:20:15Z

/rtm

* docs(community): update latest community documentation (#4407) * chore: update meetings.json and newsrooom_videos.json (#4410) * chore: update meetings.json and newsrooom_videos.json (#4405) * chore: update meetings.json, newsrooom_videos.json and dashboard.json * Update meetings.json --------- Co-authored-by: asyncapi-bot <info@asyncapi.io> Co-authored-by: Eve <bot+eve@asyncapi.io> Co-authored-by: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com> * chore: update meetings.json and newsrooom_videos.json (#4411) * fix: #4065 Made Case Studies page table section mobile responsive (#4403) * fixes #4065. Made Case Studie page mobile responsive * fixes #4065. Made Case Studie page mobile responsive * fix: #4381 --------- Co-authored-by: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com> * chore(deps): bump axios from 1.8.2 to 1.12.1 (#4413) * chore(deps): bump @babel/runtime and next-language-detector (#4414) * chore: update tools.json (#4417) * chore: update meetings.json and newsrooom_videos.json (#4419) * ci: update of files from global .github repo (#4418) * fix: broken AsyncAPI contributing guidelines link (#4395) (#4398) Co-authored-by: SanidhyaMadheshia <sanidhyamadheshia@gmail.com> Co-authored-by: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com> Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> --------- Co-authored-by: Chan <bot+chan@asyncapi.io> Co-authored-by: asyncapi-bot <info@asyncapi.io> Co-authored-by: Eve <bot+eve@asyncapi.io> Co-authored-by: namanjain24-sudo <namanjainpy@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: SanidhyaMadheshia <139427620+SanidhyaMadheshia@users.noreply.github.com> Co-authored-by: SanidhyaMadheshia <sanidhyamadheshia@gmail.com> Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com>

fix: broken AsyncAPI contributing guidelines link (asyncapi#4395)

a8978cc

SanidhyaMadheshia requested review from TRohit20, asyncapi-bot-eve and thulieblack as code owners September 7, 2025 13:37

asyncapi-bot requested review from CBID2 and bandantonio September 7, 2025 13:37

coderabbitai bot reviewed Sep 7, 2025

View reviewed changes

bandantonio reviewed Sep 7, 2025

View reviewed changes

Merge branch 'master' into fix-issue-4395

f225108

Merge branch 'master' into fix-issue-4395

9364f38

coderabbitai bot reviewed Sep 14, 2025

View reviewed changes

Update index.md

d46a5e9

asyncapi-bot requested a review from bandantonio September 14, 2025 10:48

Merge branch 'master' into fix-issue-4395

d88a6eb

thulieblack approved these changes Sep 17, 2025

View reviewed changes

asyncapi-bot added the ready-to-merge label Sep 17, 2025

asyncapi-bot merged commit 2d77a72 into asyncapi:master Sep 17, 2025
20 checks passed

coderabbitai bot mentioned this pull request Nov 16, 2025

docs: fix broken community repository links #4600

Merged

Uh oh!

fix: broken AsyncAPI contributing guidelines link (#4395) #4398

fix: broken AsyncAPI contributing guidelines link (#4395) #4398

Uh oh!

Conversation

SanidhyaMadheshia commented Sep 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

netlify bot commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for asyncapi-website ready!

Uh oh!

coderabbitai bot commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

codecov bot commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

asyncapi-bot commented Sep 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

bandantonio Sep 7, 2025

Choose a reason for hiding this comment

Uh oh!

SanidhyaMadheshia Sep 7, 2025

Choose a reason for hiding this comment

Uh oh!

thulieblack Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

sambhavgupta0705 Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

SanidhyaMadheshia commented Sep 8, 2025

Uh oh!

bandantonio commented Sep 8, 2025

Uh oh!

SanidhyaMadheshia commented Sep 8, 2025

Uh oh!

bandantonio commented Sep 8, 2025

Uh oh!

sambhavgupta0705 commented Sep 14, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

SanidhyaMadheshia commented Sep 14, 2025

Uh oh!

SanidhyaMadheshia commented Sep 16, 2025

Uh oh!

thulieblack left a comment

Choose a reason for hiding this comment

Uh oh!

thulieblack commented Sep 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SanidhyaMadheshia commented Sep 7, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Sep 7, 2025 •

edited

Loading

coderabbitai bot commented Sep 7, 2025 •

edited

Loading

codecov bot commented Sep 7, 2025 •

edited

Loading

asyncapi-bot commented Sep 7, 2025 •

edited

Loading