Skip to content

Test pull requests #13

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Test pull requests #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1183f18
Add CONTRIBUTING.md
maneatingape Jul 25, 2025
2fc1b76
Test commit
maneatingape Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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,
Expand Down