🚧 kona-preimage (#14)

* init `kona-preimage`

* updates

* Add spin lock

* new just directives

* progress

* cannon test for simple revm

* lint

* `fpvm-tests`

* lint

* Add minimal & asterisc FPVM tests

* preimage mods

* changes

* lint

* temp changes

* updates

* move to a more slim malloc

doc

* move around imports

* lint

* Remove `ReadHandle` & `WriteHandle`

* 🧹; `CONTRIBUTING.md`

* 🧹

.github/workflows/ci.yaml

@@ -1,9 +1,7 @@
 name: Rust CI
 on: [push]
-
 env:
   CARGO_TERM_COLOR: always
-
 jobs:
   cargo-tests:
     runs-on: ubuntu-latest
@@ -50,7 +48,7 @@ jobs:
           cache-on-failure: true
       - name: build
         id: build
-        run: cargo build --workspace --all --locked 
+        run: cargo build --workspace --all --locked
   cargo-doc:
     runs-on: ubuntu-latest
     timeout-minutes: 20
@@ -69,4 +67,3 @@ jobs:
         run: RUSTDOCFLAGS="-D warnings" cargo doc --all --no-deps --document-private-items
       - name: doctest
         run: cargo test --doc --all --locked
-

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Thank you for wanting to contribute! Before contributing to this repository, please read through this document, the
+[book][book], and discuss the change you wish to make via issue or in the development telegram.
+
+## Dependencies
+
+Before working with this repository locally, you'll need to install several dependencies:
+
+- [Docker](https://www.docker.com/) for cross-compilation.
+- [just](https://github.com/casey/just) for our command-runner scripts.
+- The [Rust toolchain](https://rustup.rs/)
+- The [Golang toolchain](https://go.dev/dl/)
+
+**Optional**
+
+- [mdbook](https://github.com/rust-lang/mdBook) to contribute to the [book][book]
+  - [mdbook-template](https://github.com/sgoudham/mdbook-template)
+  - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)
+
+## Pull Request Process
+
+1. Before anything, [create an issue](https://github.com/ethereum-optimism/kona/issues/new) to discuss the change you're
+   wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes.
+1. Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can
+   be ran locally via the `justfile`s in the repository.
+1. Make sure to update any documentation that has gone stale as a result of the change, in the `README` files, the [book][book],
+   and in rustdoc comments.
+1. Once you have sign-off from a maintainer, you may merge your pull request yourself if you have permissions to do so.
+   If not, the maintainer who approves your pull request will add it to the merge queue.
+
+[book]: https://static.optimism.io/kona