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

doc(services/redb): add doc for redb service backend #2538

Merged
merged 2 commits into from
Jun 26, 2023

Conversation

oowl
Copy link
Member

@oowl oowl commented Jun 26, 2023

add missing doc for #2526

@oowl
Copy link
Member Author

oowl commented Jun 26, 2023

Maybe we need a GitHub issue or PR template so that we can make sure our PR description is clear and understandable. cc @Xuanwo

@Xuanwo
Copy link
Member

Xuanwo commented Jun 26, 2023

GitHub issue or PR template so that we can make sure our PR description is clear and understandable.

template is just a template which can't make sure description is clear and understandable. OpenDAL is a small community that most problems can be resolved by asking.

@oowl oowl force-pushed the doc/service/redb branch from 450f945 to 30b2d53 Compare June 26, 2023 03:27
Copy link
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

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

Thanks!

@Xuanwo Xuanwo merged commit e1f81f3 into apache:main Jun 26, 2023
@oowl
Copy link
Member Author

oowl commented Jun 26, 2023

GitHub issue or PR template so that we can make sure our PR description is clear and understandable.

template is just a template which can't make sure description is clear and understandable. OpenDAL is a small community that most problems can be resolved by asking.

I mean that If we have a PR template, it will reduce the workload of contributors. By defining a format for describing PRs, we can guide contributors to include all necessary information in their PRs, such as describing the problem they fixed, indicating if a test file needs to be added, and specifying if documentation needs to be updated. This will make it easier for reviewers to understand the intent of the PR and increase the chances of it being accepted.

@Xuanwo
Copy link
Member

Xuanwo commented Jun 26, 2023

This will make it easier for reviewers to understand the intent of the PR and increase the chances of it being accepted.

OpenDAL is not yet at a stage where reviewers require complex information. All the pull requests we have received so far are small and straightforward. We will only ask for clarification when necessary, rather than burdening contributors with unnecessary requests.

While I acknowledge that this is a good idea and considered best practice, I don't believe it's necessary for OpenDAL. Thank you. Maybe we will add this while OpenDAL has 500 contributors.

@PsiACE PsiACE mentioned this pull request Jun 27, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants