From 1183f189ebca6f631b1b749bea05bfb1fd0e19b2 Mon Sep 17 00:00:00 2001 From: maneatingape <44142177+maneatingape@users.noreply.github.com> Date: Fri, 25 Jul 2025 17:09:53 +0100 Subject: [PATCH 1/2] Add CONTRIBUTING.md --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..12f0344 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing + +I hope that you've enjoyed reading these solutions as much as I enjoyed writing them. +They're pretty fast and clean...but could you make them even *faster and cleaner*? + +If you have thought of an improvement then please +[open a pull request](https://github.com/maneatingape/advent-of-code-rust/compare). +Contributions are encouraged and valued. It should generally fall into one of the +following two categories: + +* **Bug Fix** Solutions try to be as general as possible but can't test for every input. Your pull + request fixes an incorrect answer for your input or prevents a panic. +* **Performance Improvement** Your pull request gives a significant (> 10%) performance improvement. + This could be achieved by using a better algorithm, better low level optimizations + or by applying the portable SIMD library. + +## Legal Notice + +When contributing to this project, you must agree that you have authored 100% of the content, +that you have the necessary rights to the content and that the content you contribute +may be provided under the project licence. + +## Guidelines + +Pull requests should meet the following baseline standards: + +* Commit messages and pull request title are clear and informative. +* Code style matches the existing code. This one is somewhat subjective but try to "fit in" by + using the same naming conventions. Code should be portable, avoiding any architecture + specific intrinsics. +* No performance regressions. Benchmark the new solution versus the original and try to keep it + within a ±5% margin of error. Bug fixes have more leniency to reduce performance. +* Tests should pass. +* Code is formatted using `rustfmt`. +* Code is linted using `clippy`. + +Formatting and linting can be executed by running [`just`](https://github.com/casey/just) +(if installed) on the command line at the project root, or alternatively copying and pasting +the commands from `justfile` into the terminal. From 2fc1b76c5398f37be07489f276054973842ad86e Mon Sep 17 00:00:00 2001 From: maneatingape <44142177+maneatingape@users.noreply.github.com> Date: Fri, 25 Jul 2025 17:17:12 +0100 Subject: [PATCH 2/2] Test commit --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b192087..e3a3882 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +Hello world. + # Advent of Code [![checks-badge]][checks-link] [![docs-badge]][docs-link] Complete 2024 to 2015 entries written in Rust for the annual [Advent of Code] challenge,