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

Add commit guidance to CONTRIBUTION.MD #991

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

jbesraa
Copy link
Contributor

@jbesraa jbesraa commented Jun 21, 2024

resolves #978

Copy link
Contributor

github-actions bot commented Jun 21, 2024

🐰Bencher

ReportWed, June 26, 2024 at 14:09:44 UTC
ProjectStratum v2 (SRI)
Branch2024-06-21-commit-guidance
Testbedsv1

🚨 2 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
serialize_deserialize_authorizeRAM Accesses (accesses)🚨 (view plot | view alert)298.00 (+1.05%)297.96 (100.01%)
serialize_deserialize_handle_authorizeRAM Accesses (accesses)🚨 (view plot | view alert)368.00 (+1.12%)367.32 (100.18%)

Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Upper Boundary
accesses | (%)
get_authorize✅ (view plot)8,504.00 (+0.80%)8,726.94 (97.45%)✅ (view plot)3,746.00 (+0.15%)3,855.71 (97.15%)✅ (view plot)5,249.00 (+0.08%)5,402.10 (97.17%)✅ (view plot)7.00 (-11.90%)10.40 (67.31%)✅ (view plot)92.00 (+2.16%)94.10 (97.77%)
get_submit✅ (view plot)95,475.00 (-0.08%)96,143.87 (99.30%)✅ (view plot)59,439.00 (-0.05%)59,779.65 (99.43%)✅ (view plot)85,360.00 (-0.05%)85,838.01 (99.44%)✅ (view plot)49.00 (-11.09%)62.58 (78.30%)✅ (view plot)282.00 (-0.04%)287.74 (98.01%)
get_subscribe✅ (view plot)7,957.00 (-0.26%)8,271.92 (96.19%)✅ (view plot)2,841.00 (+0.39%)2,940.12 (96.63%)✅ (view plot)3,972.00 (+0.46%)4,099.95 (96.88%)✅ (view plot)13.00 (-19.66%)19.82 (65.60%)✅ (view plot)112.00 (-0.58%)116.96 (95.76%)
serialize_authorize✅ (view plot)12,257.00 (+0.41%)12,505.17 (98.02%)✅ (view plot)5,317.00 (+0.11%)5,426.71 (97.98%)✅ (view plot)7,412.00 (+0.06%)7,565.44 (97.97%)✅ (view plot)10.00 (-7.41%)13.38 (74.73%)✅ (view plot)137.00 (+1.05%)140.29 (97.65%)
serialize_deserialize_authorize✅ (view plot)24,554.00 (+0.34%)24,711.24 (99.36%)✅ (view plot)9,898.00 (-0.02%)10,026.68 (98.72%)✅ (view plot)13,959.00 (-0.05%)14,151.75 (98.64%)✅ (view plot)33.00 (-9.79%)41.62 (79.29%)🚨 (view plot | view alert)298.00 (+1.05%)297.96 (100.01%)
serialize_deserialize_handle_authorize✅ (view plot)30,293.00 (+0.48%)30,347.88 (99.82%)✅ (view plot)12,101.00 (+0.05%)12,210.71 (99.10%)✅ (view plot)17,118.00 (+0.00%)17,280.58 (99.06%)✅ (view plot)59.00 (+0.40%)64.67 (91.23%)🚨 (view plot | view alert)368.00 (+1.12%)367.32 (100.18%)
serialize_deserialize_handle_submit✅ (view plot)126,372.00 (-0.03%)127,032.69 (99.48%)✅ (view plot)73,224.00 (-0.04%)73,621.57 (99.46%)✅ (view plot)104,947.00 (-0.04%)105,513.89 (99.46%)✅ (view plot)120.00 (-0.42%)131.31 (91.38%)✅ (view plot)595.00 (+0.03%)599.18 (99.30%)
serialize_deserialize_handle_subscribe✅ (view plot)27,457.00 (+0.01%)27,601.52 (99.48%)✅ (view plot)9,643.00 (+0.12%)9,742.12 (98.98%)✅ (view plot)13,642.00 (+0.14%)13,776.01 (99.03%)✅ (view plot)61.00 (-7.37%)73.88 (82.57%)✅ (view plot)386.00 (+0.06%)388.55 (99.34%)
serialize_deserialize_submit✅ (view plot)114,999.00 (-0.07%)115,655.20 (99.43%)✅ (view plot)68,001.00 (-0.08%)68,404.14 (99.41%)✅ (view plot)97,559.00 (-0.09%)98,152.61 (99.40%)✅ (view plot)65.00 (-6.39%)75.30 (86.32%)✅ (view plot)489.00 (+0.18%)492.39 (99.31%)
serialize_deserialize_subscribe✅ (view plot)22,888.00 (+0.05%)23,112.96 (99.03%)✅ (view plot)8,195.00 (+0.11%)8,297.86 (98.76%)✅ (view plot)11,543.00 (+0.12%)11,683.29 (98.80%)✅ (view plot)36.00 (-8.63%)44.09 (81.65%)✅ (view plot)319.00 (+0.14%)321.54 (99.21%)
serialize_submit✅ (view plot)99,792.00 (-0.10%)100,472.00 (99.32%)✅ (view plot)61,483.00 (-0.05%)61,829.06 (99.44%)✅ (view plot)88,207.00 (-0.05%)88,691.56 (99.45%)✅ (view plot)49.00 (-12.04%)62.30 (78.65%)✅ (view plot)324.00 (-0.21%)329.21 (98.42%)
serialize_subscribe✅ (view plot)11,294.00 (-0.29%)11,607.70 (97.30%)✅ (view plot)4,188.00 (+0.27%)4,287.12 (97.69%)✅ (view plot)5,829.00 (+0.29%)5,959.18 (97.82%)✅ (view plot)15.00 (-8.33%)18.98 (79.05%)✅ (view plot)154.00 (-0.80%)159.78 (96.38%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Jun 21, 2024

🐰Bencher

ReportWed, June 26, 2024 at 14:09:46 UTC
ProjectStratum v2 (SRI)
Branch2024-06-21-commit-guidance
Testbedsv2

🚨 11 ALERTS: Threshold Boundary Limits exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client_sv2_mining_message_submit_standardL2 Accesses (accesses)🚨 (view plot | view alert)26.00 (+47.02%)23.55 (110.38%)
client_sv2_mining_message_submit_standard_serializeL2 Accesses (accesses)🚨 (view plot | view alert)56.00 (+17.94%)53.18 (105.30%)
client_sv2_mining_message_submit_standard_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)10,585.00 (+0.40%)10,567.30 (100.17%)
client_sv2_mining_message_submit_standard_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)15,399.00 (+0.38%)15,373.41 (100.17%)
client_sv2_mining_message_submit_standard_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)90.00 (+7.36%)89.73 (100.30%)
client_sv2_open_channel_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)8,027.00 (+0.53%)8,009.69 (100.22%)
client_sv2_open_channel_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)11,673.00 (+0.50%)11,648.39 (100.21%)
client_sv2_open_channel_serialize_deserializeL2 Accesses (accesses)🚨 (view plot | view alert)84.00 (+14.26%)82.68 (101.60%)
client_sv2_setup_connectionL2 Accesses (accesses)🚨 (view plot | view alert)15.00 (+63.31%)13.96 (107.42%)
client_sv2_setup_connection_serialize_deserializeInstructions (instructions)🚨 (view plot | view alert)14,855.00 (+0.29%)14,837.01 (100.12%)
client_sv2_setup_connection_serialize_deserializeL1 Accesses (accesses)🚨 (view plot | view alert)21,812.00 (+0.28%)21,785.19 (100.12%)

Click to view all benchmark results
BenchmarkEstimated CyclesEstimated Cycles Results
estimated cycles | (Δ%)
Estimated Cycles Upper Boundary
estimated cycles | (%)
InstructionsInstructions Results
instructions | (Δ%)
Instructions Upper Boundary
instructions | (%)
L1 AccessesL1 Accesses Results
accesses | (Δ%)
L1 Accesses Upper Boundary
accesses | (%)
L2 AccessesL2 Accesses Results
accesses | (Δ%)
L2 Accesses Upper Boundary
accesses | (%)
RAM AccessesRAM Accesses Results
accesses | (Δ%)
RAM Accesses Upper Boundary
accesses | (%)
client_sv2_handle_message_common✅ (view plot)2,077.00 (+1.30%)2,129.07 (97.55%)✅ (view plot)473.00 (+0.49%)486.40 (97.25%)✅ (view plot)732.00 (-0.03%)755.25 (96.92%)✅ (view plot)10.00 (+43.62%)10.68 (93.67%)✅ (view plot)37.00 (+0.91%)38.61 (95.83%)
client_sv2_handle_message_mining✅ (view plot)8,253.00 (+0.67%)8,339.43 (98.96%)✅ (view plot)2,137.00 (+0.46%)2,171.37 (98.42%)✅ (view plot)3,158.00 (+0.43%)3,216.06 (98.19%)✅ (view plot)39.00 (+1.20%)43.61 (89.43%)✅ (view plot)140.00 (+0.80%)142.05 (98.56%)
client_sv2_mining_message_submit_standard✅ (view plot)6,316.00 (+0.61%)6,392.98 (98.80%)✅ (view plot)1,750.00 (+0.03%)1,763.19 (99.25%)✅ (view plot)2,546.00 (-0.30%)2,575.94 (98.84%)🚨 (view plot | view alert)26.00 (+47.02%)23.55 (110.38%)✅ (view plot)104.00 (+0.12%)106.96 (97.23%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)14,661.00 (-0.77%)15,033.47 (97.52%)✅ (view plot)4,694.00 (+0.01%)4,707.19 (99.72%)✅ (view plot)6,751.00 (-0.05%)6,775.24 (99.64%)🚨 (view plot | view alert)56.00 (+17.94%)53.18 (105.30%)✅ (view plot)218.00 (-1.97%)229.97 (94.80%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)27,469.00 (-0.04%)27,845.66 (98.65%)🚨 (view plot | view alert)10,585.00 (+0.40%)10,567.30 (100.17%)🚨 (view plot | view alert)15,399.00 (+0.38%)15,373.41 (100.17%)🚨 (view plot | view alert)90.00 (+7.36%)89.73 (100.30%)✅ (view plot)332.00 (-0.84%)345.31 (96.14%)
client_sv2_open_channel✅ (view plot)4,417.00 (-1.66%)4,610.65 (95.80%)✅ (view plot)1,461.00 (+0.06%)1,474.45 (99.09%)✅ (view plot)2,157.00 (+0.20%)2,173.00 (99.26%)✅ (view plot)11.00 (-8.05%)15.23 (72.23%)✅ (view plot)63.00 (-3.24%)68.16 (92.43%)
client_sv2_open_channel_serialize✅ (view plot)14,006.00 (-1.46%)14,463.57 (96.84%)✅ (view plot)5,064.00 (+0.02%)5,077.45 (99.74%)✅ (view plot)7,321.00 (+0.04%)7,339.37 (99.75%)✅ (view plot)42.00 (+12.56%)42.04 (99.91%)✅ (view plot)185.00 (-3.50%)198.98 (92.97%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)22,523.00 (-0.51%)23,023.95 (97.82%)🚨 (view plot | view alert)8,027.00 (+0.53%)8,009.69 (100.22%)🚨 (view plot | view alert)11,673.00 (+0.50%)11,648.39 (100.21%)🚨 (view plot | view alert)84.00 (+14.26%)82.68 (101.60%)✅ (view plot)298.00 (-2.12%)315.03 (94.59%)
client_sv2_setup_connection✅ (view plot)4,659.00 (-0.83%)4,764.75 (97.78%)✅ (view plot)1,502.00 (+0.05%)1,515.45 (99.11%)✅ (view plot)2,274.00 (-0.12%)2,299.69 (98.88%)🚨 (view plot | view alert)15.00 (+63.31%)13.96 (107.42%)✅ (view plot)66.00 (-2.76%)69.64 (94.77%)
client_sv2_setup_connection_serialize✅ (view plot)15,942.00 (-1.95%)16,501.05 (96.61%)✅ (view plot)5,963.00 (+0.01%)5,976.45 (99.77%)✅ (view plot)8,662.00 (+0.08%)8,677.76 (99.82%)✅ (view plot)49.00 (+9.61%)49.21 (99.57%)✅ (view plot)201.00 (-4.69%)217.87 (92.26%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)35,382.00 (-0.42%)35,748.31 (98.98%)🚨 (view plot | view alert)14,855.00 (+0.29%)14,837.01 (100.12%)🚨 (view plot | view alert)21,812.00 (+0.28%)21,785.19 (100.12%)✅ (view plot)110.00 (+10.18%)113.29 (97.10%)✅ (view plot)372.00 (-1.97%)384.83 (96.66%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Jun 21, 2024

🐰Bencher

ReportWed, June 26, 2024 at 14:09:48 UTC
ProjectStratum v2 (SRI)
Branch991/merge
Testbedsv1

🚨 1 ALERT: Threshold Boundary Limit exceeded!
BenchmarkMeasure (units)ViewValueLower BoundaryUpper Boundary
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handleLatency (nanoseconds (ns))🚨 (view plot | view alert)788.61 (+5.35%)780.99 (100.98%)

Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client-submit-serialize✅ (view plot)6,500.90 (-6.00%)7,363.84 (88.28%)
client-submit-serialize-deserialize✅ (view plot)7,479.00 (-4.58%)8,333.46 (89.75%)
client-submit-serialize-deserialize-handle/client-submit-serialize-deserialize-handle✅ (view plot)8,032.50 (-4.42%)8,853.47 (90.73%)
client-sv1-authorize-serialize-deserialize-handle/client-sv1-authorize-serialize-deserialize-handle✅ (view plot)896.35 (-0.21%)926.13 (96.78%)
client-sv1-authorize-serialize-deserialize/client-sv1-authorize-serialize-deserialize✅ (view plot)695.38 (-0.22%)717.50 (96.92%)
client-sv1-authorize-serialize/client-sv1-authorize-serialize✅ (view plot)244.76 (-1.30%)255.08 (95.96%)
client-sv1-get-authorize/client-sv1-get-authorize✅ (view plot)156.33 (-0.52%)162.37 (96.28%)
client-sv1-get-submit✅ (view plot)6,228.00 (-6.76%)7,156.49 (87.03%)
client-sv1-get-subscribe/client-sv1-get-subscribe✅ (view plot)277.81 (-0.26%)291.02 (95.46%)
client-sv1-subscribe-serialize-deserialize-handle/client-sv1-subscribe-serialize-deserialize-handle🚨 (view plot | view alert)788.61 (+5.35%)780.99 (100.98%)
client-sv1-subscribe-serialize-deserialize/client-sv1-subscribe-serialize-deserialize✅ (view plot)638.75 (+3.88%)639.42 (99.90%)
client-sv1-subscribe-serialize/client-sv1-subscribe-serialize✅ (view plot)200.62 (-2.83%)219.80 (91.28%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

Copy link
Contributor

github-actions bot commented Jun 21, 2024

🐰Bencher

ReportWed, June 26, 2024 at 14:09:45 UTC
ProjectStratum v2 (SRI)
Branch2024-06-21-commit-guidance
Testbedsv2
Click to view all benchmark results
BenchmarkLatencyLatency Results
nanoseconds (ns) | (Δ%)
Latency Upper Boundary
nanoseconds (ns) | (%)
client_sv2_handle_message_common✅ (view plot)44.90 (+0.74%)45.26 (99.19%)
client_sv2_handle_message_mining✅ (view plot)74.72 (+2.46%)80.50 (92.83%)
client_sv2_mining_message_submit_standard✅ (view plot)14.65 (-0.03%)14.69 (99.70%)
client_sv2_mining_message_submit_standard_serialize✅ (view plot)264.53 (+0.09%)283.81 (93.21%)
client_sv2_mining_message_submit_standard_serialize_deserialize✅ (view plot)584.59 (-1.58%)627.61 (93.15%)
client_sv2_open_channel✅ (view plot)165.27 (-0.19%)171.23 (96.52%)
client_sv2_open_channel_serialize✅ (view plot)281.02 (-0.86%)293.50 (95.75%)
client_sv2_open_channel_serialize_deserialize✅ (view plot)377.11 (-0.33%)423.92 (88.96%)
client_sv2_setup_connection✅ (view plot)164.87 (+0.33%)175.19 (94.11%)
client_sv2_setup_connection_serialize✅ (view plot)454.64 (-4.28%)505.72 (89.90%)
client_sv2_setup_connection_serialize_deserialize✅ (view plot)971.45 (+0.09%)1,037.71 (93.61%)

Bencher - Continuous Benchmarking
View Public Perf Page
Docs | Repo | Chat | Help

@plebhash plebhash merged commit 20c16ea into stratum-mining:dev Jun 26, 2024
13 checks passed
@plebhash plebhash mentioned this pull request Aug 18, 2024
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.

3 participants