docs: updating the readme #65
Conversation
There was a problem hiding this comment.
left few comments.
regarding contrib guide and CoC, please do not copy paste those. If you think we need file to be in the repo, them please have them but with simple into text and a link to original files from .github repo, can be a link with HTML a tag and target blank to trigger opening link in another tab
|
@alequetzalli maybe you wanna have a look 😉 |
There was a problem hiding this comment.
Hey @Souvikns ! 😀😀😀 Hope you are well! I went ahead and added writing suggestions to help you further improve our readMEs. Let me know if something doesn't make sense, I hope this is helpful 👯
|
@derberg can you check once, I have made all the requested changes. Hade to change the |
|
@alequetzalli I did not closely follow all suggestions you made to @Souvikns but definitely whatever suggestions were done to CONTRIBUTING and CODE_OF_CONDUCT files, should be ported to the same files in @Souvikns please remove CODE_OF_CONDUCT file. And sorry but CONTRIBUTION guide too 😓 . Why? because of this PR I got to my GitHub Action -> derberg/manage-files-in-multiple-repositories#22. Once I merge and release it, we will use it in AsyncAPI, so we will no longer only push with bot all global GitHub Action workflow files, but also the basic files like CONTRIBUTION guide or CODE_OF_CONDUCT 😄 so whatever you do now will be lost in few days because of killer bot 😄 Just leave the CODE_OF_CONDUCT and previous version of CONTRIBUTION file after fixes from Alejandra, and only in README under Contributing section write I hope you are not mad cause of the change in plans. It is fresh PR, something we thought to support too but waited for confirmation from other non-AsyncAPI related communities that it is actually valid thing to do with my GH action |
|
@Souvikns sorry 😅 rever and then extend readme |
|
Kudos, SonarCloud Quality Gate passed!
|
|
@derberg It is ready to be reviewed. |
| To run `@asyncapi/cli`, you'll need Node.js >=v10 | ||
|
|
||
| Run this terminal command to check your Node.js version: |
There was a problem hiding this comment.
Maybe it was here, or maybe it was in another repo, but did I give you a hint to describe the requirements in table form, such as?
- NodeJS >= v10
Was this removed during the review from Łukasz?
Overall good, I have only this question.
There was a problem hiding this comment.
Maybe I missed it I will update it later, 👍🏻
|
🎉 This PR is included in version 0.6.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
** Description**
As of now, the readme is very plain and it does not provide much help.
As a user, I would like to see the following things.
As an open-source contributor, I would like to see the following things.