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

PR Template - add Type of Change: Performance #4875

Merged
merged 1 commit into from
Jan 18, 2024
Merged

Conversation

intelliot
Copy link
Collaborator

High Level Overview of Change

Some PRs aim to improve performance. Other PRs impact performance, either positively or negatively. Other PRs are expected to have some unknown impact. In all of these cases, it would be helpful to have a Type of Change checkbox for "Performance".

Context of Change

Other PRs have already added this checkbox. By adding it to the template, PR authors will be reminded that such changes should be explicitly called out and described. Additionally, there are four questions that the RippleX Performance Team has requested answers for:

  1. Is this a new feature, bug fix, or improvement to existing functionality?
  2. What behavior/functionality does the change impact?
  3. In what processing can the impact be measured? Be as specific as possible - e.g. RPC client call, payment transaction that involves LOB, AMM, caching, DB operations, etc.
  4. Does this change affect concurrent processing - e.g. does it involve acquiring locks, multi-threaded processing, or async processing?

These details should be provided for all PRs that the Perf team should pay attention to.

Type of Change

  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)

@intelliot intelliot requested review from mtrippled, sophiax851, Bronek, scottschurr and ckeshava and removed request for mtrippled January 10, 2024 06:10
Copy link
Collaborator

@scottschurr scottschurr left a comment

Choose a reason for hiding this comment

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

👍 LGTM.

@intelliot intelliot added this to the 2.0.1 milestone Jan 12, 2024
@intelliot intelliot added the Perf impact not expected Change is not expected to improve nor harm performance. label Jan 12, 2024
@intelliot intelliot self-assigned this Jan 12, 2024
@intelliot
Copy link
Collaborator Author

ok for 2.0.1: only touches a markdown file - no code change.

@intelliot intelliot removed the request for review from Bronek January 17, 2024 19:04
@intelliot intelliot assigned sophiax851 and unassigned intelliot Jan 17, 2024
Copy link
Collaborator

@sophiax851 sophiax851 left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks.

@intelliot intelliot merged commit 861bd1a into develop Jan 18, 2024
32 checks passed
@intelliot intelliot deleted the perf-pr-template branch January 18, 2024 00:37
sophiax851 pushed a commit to sophiax851/rippled that referenced this pull request Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Perf impact not expected Change is not expected to improve nor harm performance.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants