chore: codebase refactoring and cleanup and documentation update #1886
Conversation
AayushSaini101
requested review from
Amzani,
Shurtu-gal,
Souvikns and
asyncapi-bot-eve
as code owners
|
|
@asyncapi/bounty_team |
AayushSaini101
changed the title
|
/u |
3 similar comments
|
/u |
|
/u |
|
/u |
AayushSaini101
force-pushed
the
1853
branch
2 times, most recently
from
5bf59c2 to
2a5d404
Compare
|
/u |
Souvikns
left a comment
Souvikns
left a comment
There was a problem hiding this comment.
Looks good, just there are some functions that are over the complexity limit of 15, feel free to refactor them, when you have time.
|
Shurtu-gal
left a comment
Shurtu-gal
left a comment
There was a problem hiding this comment.
I have the same opinion as @Souvikns in the above review.
Also a point to be discussed should we solve the windows installation and generate command issues in same bounty?
@Shurtu-gal that's was the part of the other bounty |
|
/rtm |
github-project-automation
bot
moved this from In Progress
to Completed
in Bounty Program
5 participants
✅ Tasks
Update the AsyncAPI CLI Introduction section with diagrams
Include explanations and visuals of new and updated commands.
Document the updated CLI architecture [ Need to write again from scratch ]
Explain services, APIs, interactions, and workflows with diagrams and examples and the Server API concept : )
Revise the usage documentation
Update CLI Usage
Updater Documentation with new commands, flags, and parameters.
Add debugging steps [ Debugging and writing test cases are very hard ]
Provide step-by-step debugging and testing guidelines across all services and APIs.
Document best practices for contributing via PRs
Provide a checklist and guidelines to help contributors submit high-quality pull requests.
Codebase Refraction and Cleanup