Skip to content
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

Merged
merged 11 commits into from
Sep 6, 2021
Merged

[GSoD 2021] Refactored README.md #141

merged 11 commits into from
Sep 6, 2021

Conversation

iamrajiv
Copy link
Member

@iamrajiv iamrajiv commented Jul 8, 2021

Signed-off-by: Rajiv Ranjan Singh <rajivperfect007@gmail.com>
iamrajiv added 2 commits July 8, 2021 12:34
Signed-off-by: Rajiv Ranjan Singh <rajivperfect007@gmail.com>
Copy link

@proudofsimin proudofsimin left a 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?

Copy link

@proudofsimin proudofsimin left a 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>
@iamrajiv iamrajiv requested a review from proudofsimin July 13, 2021 00:33
Copy link

@proudofsimin proudofsimin left a 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.

README.md Show resolved Hide resolved
@iamrajiv iamrajiv requested a review from proudofsimin July 14, 2021 22:59
proudofsimin
proudofsimin previously approved these changes Jul 15, 2021
@Rohitesh-Kumar-Jain
Copy link

@iamrajiv have you added or removed any documentation from it?

@lijiarui
Copy link
Member

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:

  • Volunteers create an issue list about the high priority PR
  • PR passed all the CI tests (CLA & unit testings)
  • PR gets approved by all the project team members (if applicable, 0-1 approval)
  • PR gets approved by all volunteers (2 approvals)

So I remove your link at https://github.com/wechaty/wechaty.js.org/issues/1056

Copy link

@Rohitesh-Kumar-Jain Rohitesh-Kumar-Jain left a 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 :

  1. Extracting resources.md from readme.md
  2. Miscellanous grammatical and punctuation correction
  3. Changed heading

because refactored readme is a vague description

@Rohitesh-Kumar-Jain
Copy link

Another thing I have approved but don't place it in the merging list as the CI is yet to be passed

@Rohitesh-Kumar-Jain
Copy link

@Rohitesh-Kumar-Jain see this wechaty/wechaty.js.org#1012 (comment)

Yes it can be added then

@iamrajiv iamrajiv requested a review from lijiarui August 3, 2021 04:46
huan
huan previously approved these changes Sep 6, 2021
Copy link
Member

@huan huan left a 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!

@huan huan dismissed stale reviews from Rohitesh-Kumar-Jain and themself via bf89833 September 6, 2021 14:30
@huan huan merged commit 629abd6 into wechaty:main Sep 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants