-
Notifications
You must be signed in to change notification settings - Fork 22
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
[GSoD 2021] Refactored README.md #141
Conversation
Signed-off-by: Rajiv Ranjan Singh <rajivperfect007@gmail.com>
Signed-off-by: Rajiv Ranjan Singh <rajivperfect007@gmail.com>
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.
I would like to clarify where to review. I saw many changes in the preview but you only screenshot the table content, so I guess you meant you added the table content for it and that's what you ask me to review?
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.
I wasn't sure what you expected to do. If you only proposed to restructure this file, then the organization seems ok to fine, but if you are involved in the contents, that does require some improvement.
If you are going to enrich this section, I would suggest you to at least add some description under each section and describe what you are doing or what you expected to see instead of putting things together (they are more like notes but documents).
(For overview example you could see the one from explanation team, and instructions you could refer to the one from How-to guides.)
Signed-off-by: Rajiv Ranjan Singh <rajivperfect007@gmail.com>
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.
Well done! Just one thing I'm curious that why you changed all the languages to H4 instead of PHP and CSharp. Since "Usage" is in H2, so I suppose the languages are to be H3.
@iamrajiv have you added or removed any documentation from it? |
Hi @iamrajiv I found you add this to https://github.com/wechaty/wechaty.js.org/issues/1056 Please make sure our PR wrokflow, please add to the list after:
So I remove your link at https://github.com/wechaty/wechaty.js.org/issues/1056 |
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.
This PR involves pure refactoring, @iamrajiv for the next PRs pls do write in the description what does PR involves, i mean do write like this :
This PRs involves following changes :
- Extracting resources.md from readme.md
- Miscellanous grammatical and punctuation correction
- Changed heading
because refactored readme is a vague description
Another thing I have approved but don't place it in the merging list as the CI is yet to be passed |
Yes it can be added then |
487d9d8
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.
LGTM.
@iamrajiv Thank you very much for the improvements!
@proudofsimin @Rohitesh-Kumar-Jain Thank you very much for the review comments and the approval!
bf89833
Related: wechaty/docusaurus#1012