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

chore: update README #1390

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Conversation

chunshao90
Copy link
Contributor

@chunshao90 chunshao90 commented Dec 21, 2023

Rationale

related #1342
Add quick start to README to help users experience horaedb better.

Detailed Changes

Add quick start to README.

Test Plan

No need.

@caicancai
Copy link
Member

close: #1342

@caicancai
Copy link
Member

Updating README was supposed to be my job in the beginning, but thanks for helping me with this part of the work, although it is a trivial small job, but I feel that it is not a good sign, hope that it will not happen in the future, it may affect the experience of other developers. Of course I didn't mean any offence, I just offered my opinion and suggestions, and I also hope that the community of horaedb will become better and better

README.md Outdated Show resolved Hide resolved
@tanruixiang
Copy link
Member

tanruixiang commented Dec 21, 2023

Updating README was supposed to be my job in the beginning, but thanks for helping me with this part of the work, although it is a trivial small job, but I feel that it is not a good sign, hope that it will not happen in the future, it may affect the experience of other developers. Of course I didn't mean any offence, I just offered my opinion and suggestions, and I also hope that the community of horaedb will become better and better

@caicancai I'm sorry that the core team members caused you a bad experience. Perhaps being new to the incubator caused some chaos. But I noticed that this pr still has imperfections, as you have suggested. Maybe you can use the suggestion mode to create the review comment(detail can follow https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request and https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request), after that I can merge your review as a commit, and you will be the co-author. Thank you for your attention in this issue, you deserve to be the co-author of this pr.

@chunshao90
Copy link
Contributor Author

chunshao90 commented Dec 21, 2023

Updating README was supposed to be my job in the beginning, but thanks for helping me with this part of the work, although it is a trivial small job, but I feel that it is not a good sign, hope that it will not happen in the future, it may affect the experience of other developers. Of course I didn't mean any offence, I just offered my opinion and suggestions, and I also hope that the community of horaedb will become better and better

I didn't notice the related issue. Sorry for bringing you a bad experience. Since the repo was recently transferred to apache org, I found that the README was a little unfriendly to new users, so I simply added the quick start section. The current version is not perfect yet, you can continue to optimize it according to your ideas.

@chunshao90 chunshao90 force-pushed the add-quick-start-in-readme branch 2 times, most recently from 1a666d4 to 999ae64 Compare December 21, 2023 11:56
Co-authored-by: caicancai <2356672992@qq.com>
@chunshao90
Copy link
Contributor Author

close: #1342

I hadn't noticed this issue before. The changes I made in this PR are quite simple. You can continue to optimize it according to your ideas.

@caicancai
Copy link
Member

Updating README was supposed to be my job in the beginning, but thanks for helping me with this part of the work, although it is a trivial small job, but I feel that it is not a good sign, hope that it will not happen in the future, it may affect the experience of other developers. Of course I didn't mean any offence, I just offered my opinion and suggestions, and I also hope that the community of horaedb will become better and better

I didn't notice the related issue. Sorry for bringing you a bad experience. Since the repo was recently transferred to apache org, I found that the README was a little unfriendly to new users, so I simply added the quick start section. The current version is not perfect yet, you can continue to optimize it according to your ideas.

Thank you for your patient reply. Due to my busy work recently, I did not follow up this issue in time, for which I am sorry. From this event, I can feel that incubator-horaedb is a good community and I am looking forward to making more contributions in the future

tanruixiang
tanruixiang previously approved these changes Dec 22, 2023
Copy link
Member

@tanruixiang tanruixiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tanruixiang
Copy link
Member

Hi @caicancai, Already set you as co-author. docker image has been made, this pr is about to merge, if you have any modifications you are welcome to make them in the new pr.

@tanruixiang
Copy link
Member

@ShiKaiWi Please help to review the docker images.

@ShiKaiWi
Copy link
Member

@ShiKaiWi Please help to review the docker images.

It works.

Copy link
Member

@tanruixiang tanruixiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tanruixiang tanruixiang merged commit be7bbd1 into apache:main Dec 22, 2023
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.

4 participants