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

[improve][misc] Highlight change to threading #18025

Merged
merged 2 commits into from
Oct 13, 2022
Merged

Conversation

dave2wave
Copy link
Member

Whenever a PR changes the threading model we need to make clear that we should track these changes

Motivation

I want follow changes in the threading model in order to help understand and document Pulsar's internal architecture.

Adding a checkbox should hopefully make developers more thoughtful about explicitly noting changes to the threading model.

Modifications

Adds a checkbox about "the threading model"

Verifying this change

  • Make sure that the change passes the CI checks.

This change is to the PULL REQUEST TEMPLATE no test coverage required.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • Anything that affects deployment

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Whenever a PR changes the threading model we need to make clear that we should track these changes
@dave2wave dave2wave requested a review from lhotari October 13, 2022 01:46
@github-actions github-actions bot added the doc-not-needed Your PR changes do not impact docs label Oct 13, 2022
Copy link
Member

@michaeljmarshall michaeljmarshall left a comment

Choose a reason for hiding this comment

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

LGTM. Do we have a central doc for tracking this model? I know you've started the work, but maybe we need an issue to track its completion? It would also make sense to (eventually) document our concurrency model in the contributors guide. Thanks for starting this work @dave2wave!

@tisonkun
Copy link
Member

tisonkun commented Oct 13, 2022

document our concurrency model in the contributors guide

I'm going to sorting out the following resource to a contribution guide (doc page) like: https://devguide.python.org/:

The display, instead of the content layout, will be like: https://inlong.apache.org/community/how-to-contribute/

Perhaps start a discussion on the mailing list with a prototype later this month.

@dave2wave dave2wave merged commit dcfd40d into master Oct 13, 2022
@tisonkun tisonkun deleted the dave2wave-patch-3 branch December 4, 2022 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-not-needed Your PR changes do not impact docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants