Add CONTRIBUTING.md

[philippemnoel]

Add contribution guidelines covering setup, building, testing, and PR workflow

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.16%. Comparing base (89a1f32) to head (024f3ae).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #3   +/-   ##
=======================================
  Coverage   88.16%   88.16%           
=======================================
  Files           4        4           
  Lines        2365     2365           
=======================================
  Hits         2085     2085           
  Misses        280      280           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

📊 Benchmark Comparison

Click to expand benchmark results

group                                                                 base                                     pr
-----                                                                 ----                                     --
18_digit_precision/Decimal/16+2_decimal                               1.01    244.5±7.67ns        ? ?/sec      1.00    242.9±1.56ns        ? ?/sec
18_digit_precision/Decimal/18_digits                                  1.00    225.4±3.63ns        ? ?/sec      1.00    224.8±1.62ns        ? ?/sec
18_digit_precision/Decimal64NoScale/16+2_decimal                      1.00    114.4±1.57ns        ? ?/sec      1.00    114.1±1.51ns        ? ?/sec
18_digit_precision/Decimal64NoScale/18_digits                         1.00     54.7±1.15ns        ? ?/sec      1.02     55.9±0.92ns        ? ?/sec
aggregate_simulation/min_max_1000/Decimal64                           1.00  1575.1±17.22ns 605.5 MElem/sec     1.00   1572.4±8.45ns 606.5 MElem/sec
aggregate_simulation/min_max_1000/Decimal64NoScale                    1.00  1440.4±25.61ns 662.1 MElem/sec     1.00  1439.7±11.52ns 662.4 MElem/sec
aggregate_simulation/sum_1000/Decimal64                               1.00    746.5±9.03ns 1277.5 MElem/sec    1.01   752.7±37.21ns 1267.0 MElem/sec
aggregate_simulation/sum_1000/Decimal64NoScale                        1.00     86.0±1.41ns 10.8 GElem/sec      1.00     86.0±0.73ns 10.8 GElem/sec
batch/parse_10_decimals                                               1.01  1208.7±53.12ns  7.9 MElem/sec      1.00  1197.7±39.00ns  8.0 MElem/sec
batch/sort_10_decimals                                                1.00    368.4±5.29ns        ? ?/sec      1.03    379.9±9.52ns        ? ?/sec
batch_decimal_vs_decimal64/parse_10/Decimal                           1.01  1230.5±18.25ns  7.8 MElem/sec      1.00  1219.9±12.65ns  7.8 MElem/sec
batch_decimal_vs_decimal64/parse_10/Decimal64                         1.02  1344.1±20.85ns  7.1 MElem/sec      1.00  1313.9±29.10ns  7.3 MElem/sec
batch_decimal_vs_decimal64/sort_10/Decimal                            1.01    372.4±5.99ns 25.6 MElem/sec      1.00    369.1±6.49ns 25.8 MElem/sec
batch_decimal_vs_decimal64/sort_10/Decimal64                          1.00    173.4±2.73ns 55.0 MElem/sec      1.00    173.4±2.81ns 55.0 MElem/sec
comparison/cmp_bytes                                                  1.00      3.4±0.01ns        ? ?/sec      1.00      3.4±0.07ns        ? ?/sec
comparison/cmp_equal                                                  1.23      5.0±0.04ns        ? ?/sec      1.00      4.0±0.03ns        ? ?/sec
comparison/cmp_less                                                   1.00      4.7±0.06ns        ? ?/sec      1.00      4.7±0.02ns        ? ?/sec
decimal64_comparison/cmp_diff_scale                                   1.00      5.3±0.06ns        ? ?/sec      1.01      5.4±0.37ns        ? ?/sec
decimal64_comparison/cmp_equal                                        1.00      0.9±0.02ns        ? ?/sec      1.66      1.6±0.00ns        ? ?/sec
decimal64_comparison/cmp_less                                         1.00      5.0±0.04ns        ? ?/sec      1.00      5.0±0.05ns        ? ?/sec
decimal64_comparison/cmp_raw                                          1.00      0.9±0.02ns        ? ?/sec      1.66      1.6±0.01ns        ? ?/sec
decimal64_parse/from_str_auto                                         1.00    184.6±3.39ns    82.7 MB/sec      1.00    185.2±4.87ns    82.4 MB/sec
decimal64_parse/new/financial                                         1.00    139.8±4.07ns    88.7 MB/sec      1.00    139.7±0.90ns    88.8 MB/sec
decimal64_parse/new/max_precision                                     1.00     82.9±1.60ns   184.1 MB/sec      1.00     83.1±0.57ns   183.7 MB/sec
decimal64_parse/new/medium_decimal                                    1.01    142.2±7.28ns    87.2 MB/sec      1.00    141.3±2.14ns    87.8 MB/sec
decimal64_parse/new/medium_int                                        1.01     80.1±0.80ns   107.1 MB/sec      1.00     79.5±0.53ns   108.0 MB/sec
decimal64_parse/new/small_decimal                                     1.00    124.2±2.19ns    30.7 MB/sec      1.01    125.8±2.21ns    30.3 MB/sec
decimal64_parse/new/small_int                                         1.00     72.0±1.34ns    26.5 MB/sec      1.00     71.7±0.65ns    26.6 MB/sec
decimal64_precision_scale/from_parts                                  1.00      2.8±0.01ns        ? ?/sec      1.00      2.8±0.02ns        ? ?/sec
decimal64_precision_scale/negative_scale                              1.00     58.1±0.55ns        ? ?/sec      1.04     60.2±8.45ns        ? ?/sec
decimal64_precision_scale/with_precision_scale                        1.01   194.9±14.59ns        ? ?/sec      1.00    192.3±1.68ns        ? ?/sec
decimal64_serialization/deserialize_json                              1.00     28.8±0.22ns        ? ?/sec      1.03     29.6±0.32ns        ? ?/sec
decimal64_serialization/from_be_bytes                                 1.00      2.5±0.01ns        ? ?/sec      1.00      2.5±0.03ns        ? ?/sec
decimal64_serialization/serialize_json                                1.00     22.7±0.34ns        ? ?/sec      1.00     22.8±0.38ns        ? ?/sec
decimal64_serialization/to_be_bytes                                   1.00      2.4±0.02ns        ? ?/sec      1.00      2.4±0.02ns        ? ?/sec
decimal64_special/create_infinity                                     1.00      0.3±0.00ns        ? ?/sec      1.00      0.3±0.00ns        ? ?/sec
decimal64_special/create_nan                                          1.00      0.3±0.00ns        ? ?/sec      1.00      0.3±0.00ns        ? ?/sec
decimal64_special/is_finite                                           1.00      0.6±0.01ns        ? ?/sec      1.00      0.6±0.01ns        ? ?/sec
decimal64_special/is_infinity                                         1.00      0.6±0.01ns        ? ?/sec      1.00      0.6±0.00ns        ? ?/sec
decimal64_special/is_nan                                              1.00      0.6±0.01ns        ? ?/sec      1.00      0.6±0.00ns        ? ?/sec
decimal64_special/parse_infinity                                      1.00     29.4±0.47ns        ? ?/sec      1.00     29.4±0.43ns        ? ?/sec
decimal64_to_string/to_string/financial                               1.01    156.6±2.32ns        ? ?/sec      1.00    155.2±4.16ns        ? ?/sec
decimal64_to_string/to_string/medium_decimal                          1.00    157.9±2.52ns        ? ?/sec      1.00    157.6±9.53ns        ? ?/sec
decimal64_to_string/to_string/medium_int                              1.00     53.9±0.33ns        ? ?/sec      1.00     54.1±1.10ns        ? ?/sec
decimal64_to_string/to_string/small_decimal                           1.00    133.7±2.59ns        ? ?/sec      1.01    134.8±2.39ns        ? ?/sec
decimal64_to_string/to_string/small_int                               1.00     53.2±1.41ns        ? ?/sec      1.02     54.2±2.19ns        ? ?/sec
decimal64_vs_decimal64ns/equality/Decimal64                           1.00      0.9±0.01ns        ? ?/sec      1.66      1.6±0.00ns        ? ?/sec
decimal64_vs_decimal64ns/equality/Decimal64NoScale                    1.00      0.9±0.01ns        ? ?/sec      1.66      1.6±0.00ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64/16_digits                    1.00     83.6±1.45ns        ? ?/sec      1.00     83.9±4.09ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64/financial                    1.00    138.5±1.68ns        ? ?/sec      1.01    139.4±2.69ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64/medium_decimal               1.00    141.2±1.13ns        ? ?/sec      1.00    141.6±5.62ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64/small_int                    1.00     71.6±1.14ns        ? ?/sec      1.00     71.7±0.45ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64NoScale/16_digits             1.03     53.8±1.12ns        ? ?/sec      1.00     52.4±1.38ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64NoScale/financial             1.00     94.4±0.82ns        ? ?/sec      1.01     95.6±1.82ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64NoScale/medium_decimal        1.00     93.6±1.73ns        ? ?/sec      1.01     94.3±0.77ns        ? ?/sec
decimal64_vs_decimal64ns/parse/Decimal64NoScale/small_int             1.00     29.9±0.38ns        ? ?/sec      1.00     29.9±0.59ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64/16_digits                1.00     58.0±0.31ns        ? ?/sec      1.00     58.2±0.64ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64/financial                1.00    154.9±0.93ns        ? ?/sec      1.01    156.3±3.00ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64/medium_decimal           1.01    157.8±2.65ns        ? ?/sec      1.00    155.6±1.38ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64/small_int                1.00     53.8±1.33ns        ? ?/sec      1.01     54.6±0.99ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64NoScale/16_digits         1.00     30.4±0.57ns        ? ?/sec      1.00     30.4±0.62ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64NoScale/financial         1.00    117.7±2.44ns        ? ?/sec      1.01    118.4±0.80ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64NoScale/medium_decimal    1.01    119.0±0.58ns        ? ?/sec      1.00    117.6±0.86ns        ? ?/sec
decimal64_vs_decimal64ns/to_string/Decimal64NoScale/small_int         1.01     24.5±0.52ns        ? ?/sec      1.00     24.3±0.36ns        ? ?/sec
decimal64ns_operations/cmp_equal                                      1.00      0.9±0.01ns        ? ?/sec      1.66      1.6±0.00ns        ? ?/sec
decimal64ns_operations/cmp_less                                       1.00      0.9±0.00ns        ? ?/sec      1.67      1.6±0.01ns        ? ?/sec
decimal64ns_operations/cmp_raw                                        1.00      0.9±0.01ns        ? ?/sec      1.66      1.6±0.01ns        ? ?/sec
decimal64ns_operations/max_100_values                                 1.00     70.0±0.23ns        ? ?/sec      1.00     70.1±0.52ns        ? ?/sec
decimal64ns_operations/min_100_values                                 1.00     70.4±0.52ns        ? ?/sec      1.00     70.4±0.52ns        ? ?/sec
decimal64ns_operations/sum_100_values                                 1.00      9.0±0.16ns        ? ?/sec      1.00      9.0±0.24ns        ? ?/sec
decimal64ns_parse/new/16_digits                                       1.01     53.1±1.45ns   287.1 MB/sec      1.00     52.4±1.14ns   291.2 MB/sec
decimal64ns_parse/new/17+1_decimal                                    1.01    114.6±2.15ns   158.1 MB/sec      1.00    114.0±0.57ns   158.9 MB/sec
decimal64ns_parse/new/18_digits                                       1.00     53.7±1.17ns   319.8 MB/sec      1.02     54.9±1.33ns   312.6 MB/sec
decimal64ns_parse/new/financial                                       1.00     94.2±1.74ns   131.5 MB/sec      1.01     95.4±1.02ns   130.0 MB/sec
decimal64ns_parse/new/medium_decimal                                  1.00     93.3±0.64ns   132.8 MB/sec      1.01     94.2±0.43ns   131.6 MB/sec
decimal64ns_parse/new/medium_int                                      1.01     44.4±0.82ns   193.5 MB/sec      1.00     43.8±0.36ns   196.1 MB/sec
decimal64ns_parse/new/small_decimal                                   1.00     78.2±0.58ns    48.8 MB/sec      1.01     78.8±1.24ns    48.4 MB/sec
decimal64ns_parse/new/small_int                                       1.00     29.6±0.46ns    64.4 MB/sec      1.00     29.6±0.46ns    64.5 MB/sec
decimal64ns_serialization/deserialize_json                            1.00     25.5±0.27ns        ? ?/sec      1.01     25.7±0.23ns        ? ?/sec
decimal64ns_serialization/from_be_bytes                               1.00      2.5±0.01ns        ? ?/sec      1.00      2.5±0.03ns        ? ?/sec
decimal64ns_serialization/from_raw                                    1.00      0.6±0.00ns        ? ?/sec      1.01      0.6±0.03ns        ? ?/sec
decimal64ns_serialization/serialize_json                              1.00     20.0±0.11ns        ? ?/sec      1.00     20.0±0.13ns        ? ?/sec
decimal64ns_serialization/to_be_bytes                                 1.00      2.4±0.01ns        ? ?/sec      1.00      2.4±0.00ns        ? ?/sec
decimal64ns_special/create_infinity                                   1.00      0.3±0.00ns        ? ?/sec      1.00      0.3±0.00ns        ? ?/sec
decimal64ns_special/create_nan                                        1.00      0.3±0.00ns        ? ?/sec      1.00      0.3±0.00ns        ? ?/sec
decimal64ns_special/is_finite                                         1.00      0.6±0.00ns        ? ?/sec      1.00      0.6±0.01ns        ? ?/sec
decimal64ns_special/is_infinity                                       1.00      0.6±0.01ns        ? ?/sec      1.00      0.6±0.00ns        ? ?/sec
decimal64ns_special/is_nan                                            1.00      0.6±0.01ns        ? ?/sec      1.00      0.6±0.01ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/18_digits                  1.00     31.7±0.48ns        ? ?/sec      1.00     31.6±0.53ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/financial                  1.02    120.6±0.89ns        ? ?/sec      1.00    118.1±1.64ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/medium_decimal             1.00    118.2±2.82ns        ? ?/sec      1.00    117.6±1.92ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/medium_int                 1.00     26.2±0.42ns        ? ?/sec      1.00     26.2±0.41ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/small_decimal              1.01    101.2±1.66ns        ? ?/sec      1.00    100.5±0.80ns        ? ?/sec
decimal64ns_to_string/to_string_with_scale/small_int                  1.00     24.3±0.24ns        ? ?/sec      1.01     24.6±0.15ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal/financial                          1.00    171.4±1.22ns        ? ?/sec      1.00    171.3±2.58ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal/max_d64_precision                  1.00    153.4±1.04ns        ? ?/sec      1.00    152.9±2.50ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal/medium_decimal                     1.00    169.9±2.58ns        ? ?/sec      1.00    169.5±1.17ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal/small_int                          1.01     88.2±0.80ns        ? ?/sec      1.00     87.7±0.93ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal64/financial                        1.00    138.7±0.92ns        ? ?/sec      1.00    139.1±0.99ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal64/max_d64_precision                1.00     83.8±3.96ns        ? ?/sec      1.00     83.4±0.71ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal64/medium_decimal                   1.00    140.7±2.68ns        ? ?/sec      1.00    140.7±2.51ns        ? ?/sec
decimal_vs_decimal64/parse/Decimal64/small_int                        1.00     71.6±0.46ns        ? ?/sec      1.00     71.7±1.21ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal/financial                      1.00    108.5±2.07ns        ? ?/sec      1.02    110.3±1.76ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal/max_d64_precision              1.01    111.3±5.99ns        ? ?/sec      1.00    109.9±1.91ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal/medium_decimal                 1.00    107.1±1.07ns        ? ?/sec      1.01    107.8±0.86ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal/small_int                      1.03     71.9±1.42ns        ? ?/sec      1.00     70.1±0.98ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal64/financial                    1.01    156.4±1.40ns        ? ?/sec      1.00    154.8±0.83ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal64/max_d64_precision            1.00     58.0±0.35ns        ? ?/sec      1.00     58.1±0.66ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal64/medium_decimal               1.01    156.9±1.47ns        ? ?/sec      1.00    156.0±1.07ns        ? ?/sec
decimal_vs_decimal64/to_string/Decimal64/small_int                    1.01     53.9±0.32ns        ? ?/sec      1.00     53.3±1.36ns        ? ?/sec
from_bytes/from_bytes/large                                           1.00    256.8±1.40ns        ? ?/sec      1.00    255.6±3.21ns        ? ?/sec
from_bytes/from_bytes/medium                                          1.00     96.1±0.53ns        ? ?/sec      1.00     96.1±1.36ns        ? ?/sec
from_bytes/from_bytes/small                                           1.00     58.0±0.86ns        ? ?/sec      1.00     58.1±0.92ns        ? ?/sec
from_bytes/from_bytes_unchecked/large                                 1.00     14.9±0.08ns        ? ?/sec      1.01     15.1±0.82ns        ? ?/sec
from_bytes/from_bytes_unchecked/medium                                1.02     15.2±0.44ns        ? ?/sec      1.00     14.9±0.08ns        ? ?/sec
from_bytes/from_bytes_unchecked/small                                 1.00     15.5±0.27ns        ? ?/sec      1.01     15.6±0.22ns        ? ?/sec
memory_size_all/create_1000/Decimal                                   1.01    197.4±2.42µs  4.8 MElem/sec      1.00    194.8±2.72µs  4.9 MElem/sec
memory_size_all/create_1000/Decimal64                                 1.00    177.3±0.93µs  5.4 MElem/sec      1.00    177.6±2.13µs  5.4 MElem/sec
memory_size_all/create_1000/Decimal64NoScale                          1.02    130.3±1.60µs  7.3 MElem/sec      1.00    127.5±0.74µs  7.5 MElem/sec
parse/from_str/large_decimal                                          1.01    368.2±4.82ns   103.6 MB/sec      1.00    365.2±2.54ns   104.5 MB/sec
parse/from_str/large_int                                              1.00    279.1±4.73ns   102.5 MB/sec      1.01   282.5±10.88ns   101.3 MB/sec
parse/from_str/medium_decimal                                         1.00    169.1±2.56ns    73.3 MB/sec      1.00    169.4±2.88ns    73.2 MB/sec
parse/from_str/medium_int                                             1.03    142.0±3.88ns    60.4 MB/sec      1.00    137.8±4.18ns    62.3 MB/sec
parse/from_str/negative                                               1.01   258.4±12.17ns    73.8 MB/sec      1.00    256.1±1.56ns    74.5 MB/sec
parse/from_str/scientific                                             1.00    186.3±1.40ns    66.5 MB/sec      1.00    186.4±1.23ns    66.5 MB/sec
parse/from_str/small_decimal                                          1.01    110.8±1.99ns    34.4 MB/sec      1.00    109.8±1.69ns    34.8 MB/sec
parse/from_str/small_int                                              1.00     87.7±0.71ns    21.8 MB/sec      1.00     88.0±1.47ns    21.7 MB/sec
precision_scale/negative_scale                                        1.03    260.4±2.42ns        ? ?/sec      1.00    253.7±5.08ns        ? ?/sec
precision_scale/with_precision_scale                                  1.03    309.8±5.37ns        ? ?/sec      1.00    301.8±5.00ns        ? ?/sec
serialization/deserialize_json                                        1.00    216.3±3.65ns        ? ?/sec      1.00    216.4±1.32ns        ? ?/sec
serialization/serialize_json                                          1.08    160.4±1.35ns        ? ?/sec      1.00    148.1±1.53ns        ? ?/sec
special_values/create_infinity                                        1.00     13.7±0.07ns        ? ?/sec      1.00     13.7±0.19ns        ? ?/sec
special_values/create_nan                                             1.00     13.7±0.07ns        ? ?/sec      1.00     13.7±0.08ns        ? ?/sec
special_values/is_infinity                                            1.00      1.3±0.02ns        ? ?/sec      1.00      1.3±0.02ns        ? ?/sec
special_values/is_nan                                                 1.00      1.3±0.01ns        ? ?/sec      1.01      1.3±0.02ns        ? ?/sec
special_values/parse_infinity                                         1.00     51.7±0.27ns        ? ?/sec      1.00     51.7±0.63ns        ? ?/sec
special_values/parse_nan                                              1.00     45.9±0.62ns        ? ?/sec      1.00     45.7±0.32ns        ? ?/sec
to_string/to_string/large_decimal                                     1.00    280.5±4.46ns        ? ?/sec      1.00    281.7±6.73ns        ? ?/sec
to_string/to_string/large_int                                         1.00    172.8±0.92ns        ? ?/sec      1.00    172.3±3.08ns        ? ?/sec
to_string/to_string/medium_decimal                                    1.00    107.1±1.66ns        ? ?/sec      1.01    107.8±0.60ns        ? ?/sec
to_string/to_string/medium_int                                        1.00     95.5±0.62ns        ? ?/sec      1.00     95.2±0.60ns        ? ?/sec
to_string/to_string/negative                                          1.00    149.3±2.51ns        ? ?/sec      1.04    155.7±2.68ns        ? ?/sec
to_string/to_string/small_decimal                                     1.00     77.5±1.55ns        ? ?/sec      1.00     77.8±1.26ns        ? ?/sec
to_string/to_string/small_int                                         1.00     70.9±0.91ns        ? ?/sec      1.01     71.7±0.42ns        ? ?/sec

Compared against main branch