fix: update broken git-workflow link in welcome message#2269
fix: update broken git-workflow link in welcome message#2269Suryas2125 wants to merge 1 commit intoasyncapi:masterfrom
Conversation
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 GitHub Actions workflow to enhance first-time contributor welcome messages. Changes include redirecting documentation references to a new path, introducing a pull request message constant, and adding validation to ensure messaging configuration is properly set. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR fixes a broken link in the welcome message for first-time contributors. The "basic recommended setup" link was returning a 404 error because the git-workflow.md file was moved to a new location within the docs directory structure.
Changes:
- Updated the git-workflow.md link in the welcome message from
community/blob/master/git-workflow.mdtocommunity/blob/master/docs/010-contribution-guidelines/git-workflow.md
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| const issueMessage = `Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our [contributors guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and the instructions about a [basic recommended setup](https://github.com/asyncapi/community/blob/master/git-workflow.md) useful for opening a pull request.<br />Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out [this issue](https://github.com/asyncapi/asyncapi/issues/115).`; | ||
| const issueMessage = `Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our [contributors guide](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md) and the instructions about a [basic recommended setup](https://github.com/asyncapi/community/blob/master/docs/010-contribution-guidelines/git-workflow.md) useful for opening a pull request.<br />Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out [this issue](https://github.com/asyncapi/asyncapi/issues/115).`; |
There was a problem hiding this comment.
This file contains a warning at the top (lines 1-2) stating that it is "centrally managed in https://github.com/asyncapi/.github/" and changes made here "will be overwritten with changes made to the same file in above mentioned repo". This fix should likely be applied to the source file in the asyncapi/.github repository instead, otherwise it will be overwritten when the central repository syncs changes.
|
Hi @Suryas2125, thanks for working on this fix! I had reported this issue earlier and mentioned that I planned to work on it after maintainer confirmation. Just wanted to flag that for context and ensure we’re aligned with the contributing guidelines. cc @derberg @AceTheCreator @thulieblack — would appreciate your guidance on how you’d like to proceed. |
|
|
Thanks for the contribution. I’m closing this PR because, while there is an existing issue, it was not approved or opened for contribution before the pull request was submitted. Please make sure to follow the contribution guidelines, which explain when issues are considered ready for implementation and when pull requests are appropriate |



Description
Related issue(s)
Summary by CodeRabbit
Chores
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.