Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: expand community docs: contributor - simple contribution flow a… #1730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: expand community docs: contributor - simple contribution flow a… #1730
Changes from all commits
b9eb2b9
e117d25
d5a7881
f25ec0e
642d7fb
dc74284
c408359
91c3633
6f44317
00d2ccb
905c0d7
3cc4ab7
757113f
357ecee
f158fa5
9da16c1
5bffa7d
ffc96f7
3cd8ed5
c5433ab
fe8e455
d5337b4
42aab7a
415cbd6
ab21f21
c3757f3
389094c
70a7783
9d1c933
d088ea0
7012490
0e84b8a
9088c62
4fa2860
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Align front matter title with H1 heading
The
title
in the front matter ("Simple contribution flow for contributors") does not match the H1 heading ("Simple Contribution Flow"). For consistency in the sidebar and metadata, please align them (e.g., update the H1 to "Simple contribution flow for contributors" or vice versa).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix broken onboarding guide links
The links in the “Before Making a Contribution” section point to
/docs/community/onboarding-guide
, but the actual path is/docs/onboarding-guide
. Please update both links:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please make a numbered list in this section, not bullets, because the order here actually matters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scope "good first issues" search to AsyncAPI repo
The current URL points to GitHub’s global issues but is not scoped to AsyncAPI. It should target the community repository:
📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It will open once merged so don't worry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thulieblack Hmm, the link to the git workflow document was correct, could you please elaborate on this suggestion?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link shouldn't take them to the folder in GitHub but to the doc on the website. For example, how we did with the checklist https://github.com/asyncapi/community/blob/master/docs/onboarding-guide/docs-onboarding-checklist.md?plain=1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I got it. But this link was referring to the git workflow document that isn't listed on the docs website, that's why it was a direct link to GitHub markdown. Conventional commits is a different document, I believe we will confuse readers with such a substitution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then should we bring git workflow under the onboarding docs then? @bandantonio
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thulieblack you may be using wrong link here. It should be git-workflow instead of conventional-commits