docs(community): fix broken git workflow link in welcome message#2201
docs(community): fix broken git workflow link in welcome message#2201Harsh16gupta wants to merge 0 commit intoasyncapi:masterfrom
Conversation
Harsh16gupta
requested review from
asyncapi-bot-eve,
bandantonio,
derberg and
thulieblack
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.
📝 WalkthroughWalkthroughUpdated a GitHub Actions workflow that displays welcome messages to first-time contributors. The issueMessage now references a more specific documentation path ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📓 Common learnings🔇 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.github/workflows/welcome-first-time-contrib.yml (1)
1-2: This file is centrally managed and changes here will be overwritten.The file is synchronized from
https://github.com/asyncapi/.github/(confirmed by git history with recent sync at commit 26bac91). Any changes made to this file in this repository will be lost when the next synchronization occurs.To fix the broken link reference on line 24, you must make the corresponding change in the central
.githubrepository athttps://github.com/asyncapi/.github/instead. This ensures the fix is preserved and propagates to all synchronized repositories.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/welcome-first-time-contrib.yml
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: thulieblack
Repo: asyncapi/community PR: 1730
File: docs/onboarding-guide/contribution-flow.md:1-4
Timestamp: 2025-04-29T11:49:47.903Z
Learning: In the asyncapi/community repository, `docs/onboarding-guide/contribution-flow.md` is the correct path for contribution flow documentation, not `docs/community/onboarding-guide/contribution-flow.md`.
🔇 Additional comments (2)
.github/workflows/welcome-first-time-contrib.yml (2)
25-25: Note: AI summary inconsistency detected.The AI-generated summary mentions that the
prMessagewas modified to explicitly mention "first pull request" with adjusted wording. However, this line shows no change marker (~) in the annotated code, suggesting either:
- The text already contained "first pull request" before this PR
- The AI summary is inaccurate about changes to this line
This doesn't affect the validity of the fix, but it's worth noting the discrepancy.
24-24: The path in the workflow is correct; the file exists atdocs/010-contribution-guidelines/git-workflow.mdand the link will function properly.
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
@bandantonio shouldn't we link to website version? https://www.asyncapi.com/docs/community/010-contribution-guidelines/git-workflow
@derberg Yes, you're right. I haven't spotted the base url part right away. |
bandantonio
left a comment
bandantonio
left a comment
There was a problem hiding this comment.
The link should lead the web version of the document.
|
@bandantonio @derberg My bad! I made a mistake by opening this PR from my master branch which has merge commits. I've created a clean branch with only the fix. Can I close this and open a new PR from the clean branch with the correct website link: https://www.asyncapi.com/docs/community/010-contribution-guidelines/git-workflow |
3 participants
Description
This PR fixes a broken link in the GitHub Actions welcome message shown to first-time contributors by pointing it to the correct Git Workflow document.
Context
The welcome message includes a link to the “basic recommended setup”.
Problem (Before)
Clicking the link currently leads to a 404 page because the document was moved.
Correct Location (After)
The Git Workflow document exists at the following path:
community/docs/010-contribution-guidelines/git-workflow.mdImpact
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.