Add CONTRIBUTING.md

[JulianGCalderon]

Adds CONTRIBUTING.md to the project.

Based of https://contributing.md/generator/

The first commits adds the generated file, and the second commit changes a few thing to better suit our needs. You can review the second commit here: 093b323.

[github-actions]

Benchmark results Main vs HEAD.

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base dict_insert.cairo (JIT)	2.658 ± 0.024	2.618	2.695	1.07 ± 0.01
base dict_insert.cairo (AOT)	2.487 ± 0.023	2.447	2.522	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head dict_insert.cairo (JIT)	2.643 ± 0.020	2.617	2.677	1.03 ± 0.01
head dict_insert.cairo (AOT)	2.556 ± 0.019	2.538	2.593	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base dict_snapshot.cairo (JIT)	2.292 ± 0.027	2.255	2.328	1.05 ± 0.02
base dict_snapshot.cairo (AOT)	2.177 ± 0.026	2.140	2.226	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head dict_snapshot.cairo (JIT)	2.348 ± 0.020	2.321	2.382	1.05 ± 0.01
head dict_snapshot.cairo (AOT)	2.235 ± 0.018	2.205	2.263	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base factorial_2M.cairo (JIT)	2.637 ± 0.021	2.609	2.676	1.00 ± 0.02
base factorial_2M.cairo (AOT)	2.633 ± 0.034	2.581	2.690	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head factorial_2M.cairo (JIT)	2.713 ± 0.019	2.674	2.744	1.01 ± 0.01
head factorial_2M.cairo (AOT)	2.691 ± 0.023	2.658	2.729	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base fib_2M.cairo (JIT)	2.195 ± 0.016	2.177	2.225	1.02 ± 0.01
base fib_2M.cairo (AOT)	2.161 ± 0.019	2.135	2.200	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head fib_2M.cairo (JIT)	2.258 ± 0.020	2.228	2.289	1.02 ± 0.01
head fib_2M.cairo (AOT)	2.210 ± 0.015	2.182	2.226	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base linear_search.cairo (JIT)	2.371 ± 0.012	2.354	2.395	1.06 ± 0.02
base linear_search.cairo (AOT)	2.237 ± 0.032	2.192	2.296	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head linear_search.cairo (JIT)	2.435 ± 0.024	2.412	2.479	1.06 ± 0.01
head linear_search.cairo (AOT)	2.294 ± 0.019	2.256	2.313	1.00

Base

Command	Mean [s]	Min [s]	Max [s]	Relative
base logistic_map.cairo (JIT)	2.488 ± 0.015	2.467	2.510	1.07 ± 0.01
base logistic_map.cairo (AOT)	2.326 ± 0.014	2.308	2.342	1.00

Head

Command	Mean [s]	Min [s]	Max [s]	Relative
head logistic_map.cairo (JIT)	2.549 ± 0.012	2.534	2.569	1.08 ± 0.01
head logistic_map.cairo (AOT)	2.370 ± 0.020	2.333	2.399	1.00

[github-actions]

Benchmarking results

Benchmark for program dict_insert

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	10.658 ± 0.049	10.590	10.775	4.32 ± 0.05
cairo-native (embedded AOT)	2.465 ± 0.026	2.435	2.526	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	2.554 ± 0.016	2.521	2.571	1.04 ± 0.01

Benchmark for program dict_snapshot

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	535.1 ± 7.2	520.3	544.1	1.00
cairo-native (embedded AOT)	2168.9 ± 29.3	2128.5	2208.5	4.05 ± 0.08
cairo-native (embedded JIT using LLVM's ORC Engine)	2289.5 ± 28.9	2254.4	2336.4	4.28 ± 0.08

Benchmark for program factorial_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	4.763 ± 0.016	4.739	4.787	1.84 ± 0.02
cairo-native (embedded AOT)	2.595 ± 0.025	2.552	2.635	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	2.627 ± 0.016	2.599	2.658	1.01 ± 0.01

Benchmark for program fib_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	4.694 ± 0.010	4.681	4.718	2.20 ± 0.04
cairo-native (embedded AOT)	2.133 ± 0.034	2.096	2.193	1.00
cairo-native (embedded JIT using LLVM's ORC Engine)	2.154 ± 0.021	2.133	2.200	1.01 ± 0.02

Benchmark for program linear_search

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	590.0 ± 7.5	577.2	603.3	1.00
cairo-native (embedded AOT)	2231.7 ± 43.7	2179.0	2311.3	3.78 ± 0.09
cairo-native (embedded JIT using LLVM's ORC Engine)	2364.1 ± 17.2	2327.6	2393.8	4.01 ± 0.06

Benchmark for program logistic_map

Open benchmarks

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
Cairo-vm (Rust, Cairo 1)	387.4 ± 4.9	379.1	393.1	1.00
cairo-native (embedded AOT)	2312.4 ± 27.8	2269.9	2355.0	5.97 ± 0.10
cairo-native (embedded JIT using LLVM's ORC Engine)	2470.4 ± 34.2	2423.4	2528.1	6.38 ± 0.12

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.22%. Comparing base (76bedd6) to head (658b5a8).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1371   +/-   ##
=======================================
  Coverage   76.22%   76.22%           
=======================================
  Files         111      111           
  Lines       26520    26520           
=======================================
  Hits        20214    20214           
  Misses       6306     6306           

☔ 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.

[DiegoCivi]

Should we mention that commits need to be verified/signed?

[DiegoCivi]

Should we add a mail or maybe remove this part?

[DiegoCivi]

Oh, this section is not seen in the .md and can be completed in the future. You can dismiss this comment