rust repo template

Co-authored-by: Igor Markelov <pycckuu@users.noreply.github.com>
Co-authored-by: Alex Abdugafarov <frozenspider@users.noreply.github.com>
Co-authored-by: Nikola Mratinic <mralj@users.noreply.github.com>
Co-authored-by: Mateo Suffern <135047609+mattsuffern@users.noreply.github.com>

Author: 5 people

.githooks/pre-push

@@ -0,0 +1,34 @@
+#!/bin/sh
+set -e pipefail 
+
+# Dependency audit
+cargo deny check || {
+    echo "❌ Critical: Vulnerable dependencies detected (run 'cargo deny check')"
+    exit 1
+}
+
+# Formatting check
+cargo fmt --all -- --check || {
+    echo "❌ Formatting issues (run 'cargo fmt --all')"
+    exit 2
+}
+
+# Typo check
+typos || {
+    echo "❌ Spelling mistakes found (run 'typos --write-changes')"
+    exit 3
+}
+
+# Linting
+cargo clippy --all-targets --all-features -- -D warnings || {
+    echo "❌ Clippy violations (check warnings above)"
+    exit 4
+}
+
+# Tests
+cargo test --workspace --verbose || {
+    echo "❌ Test failures detected"
+    exit 5
+}
+
+echo "✅ All checks passed!"

.github/PULL_REQUEST_TEMPLATE/bugfix.md

@@ -0,0 +1,36 @@
+## 🧩 What was the bug?
+
+Describe what was broken or not working as expected. Link to issues if relevant.
+
+> Example: the was a random deadlock when several requests landed
+
+---
+
+### 📎 Related issues (optional)
+
+Closes #123
+
+---
+
+## 🔧 What’s been fixed?
+
+Explain the fix and any relevant changes made.
+
+> Example: Changed RWLock to Mutex
+
+---
+
+### 💬 Anything else reviewers should know?
+
+> Example: This fix touches shared validation code. Double-check for side effects!
+
+---
+
+## ✅ Checklist
+
+List what you tested to confirm the bug is resolved.
+
+- [ ] Confirmed the bug no longer occurs
+- [ ] Existing tests pass
+- [ ] Added new test(s) for the bug
+- [ ] The branch with the bugfix is named `bugfix/<name>`

.github/PULL_REQUEST_TEMPLATE/choose.md

@@ -0,0 +1,4 @@
+# Choose a PR Template
+
+- [Bug Fix](bugfix.md)
+- [New Feature](feature.md)

.github/PULL_REQUEST_TEMPLATE/feature.md

@@ -0,0 +1,22 @@
+## 🚀 What’s this PR do?
+
+The PR must explain which problem it solves or which feature it introduces. This can also be done in an issue; if this is the case, then it's ok for PR to just have closes #whatever
+
+---
+
+### 📎 Related issues (optional)
+
+Closes #123
+
+## 🧠 Context
+
+It would be helpful to point out if you solved the problem in an interesting way. For example, I've reordered the fields in a struct to achieve better struct packing, which reduced memory usage and improved CPU caching.
+Especially if you reached for some unorthodox solution or used one that at first glance seems weird/wrong, it's helpful to point this out in the PR.  Example: Usually, I would use locking primitives here, but because of {this specific reason}, we can get away w/o locking.
+If anything you think is worth pointing out or that the reviewer might find interesting or helpful, feel free to put it into the description. Example: I've decided to use RWLock instead of Mutex because Reader to Writer ratio is 5:1.
+
+## ✅ Checklist
+
+- [ ] I’ve tested this locally
+- [ ] I’ve added relevant docs or comments
+- [ ] I’ve updated or created tests if needed
+- [ ] The branch with the feature is named `feature/<name>`

.github/workflows/build-and-test.yml

@@ -0,0 +1,21 @@
+name: Build and test code
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo test --workspace --verbose --no-run
+    - name: Run tests
+      run: cargo test --workspace --verbose

.github/workflows/dependency-audit.yml

@@ -0,0 +1,41 @@
+name: Dependency security audit
+
+on:
+  push:
+    paths:
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+
+jobs:
+  security_audit:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      checks: write
+    steps:
+      - name: Check out
+        uses: actions/checkout@v4
+
+      - name: Cache audit-check build
+        id: cache-audit-check
+        uses: actions/cache@v4
+        continue-on-error: false
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-
+
+      - name: Run audit-check action
+        run: |
+          which cargo-deny || cargo install cargo-deny
+          cargo deny check

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: Docs
+
+# TODO(template)
+# GH pages seems to work properly for public repos
+on:
+  workflow_dispatch:
+
+jobs:
+  # TODO(template) remove docs publishing, when the crate is published to crates.io
+  docs:
+    permissions:
+        contents: write
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          persist-credentials: false
+
+      - name: Setup pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Clean docs folder
+        run: cargo clean --doc
+
+      # Documentation with Latex support
+      # TODO(template) if Latex is not needed
+      # just remove katex-header.html at the root and RUSTDOCFLAGS here
+      # TODO(template) update the crate name
+      - name: Build documentation
+        run: RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p mycrate
+
+      - name: Remove lock file
+        run: rm target/doc/.lock
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
+
+  publish-docs:
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: docs
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/linter.yml

@@ -0,0 +1,24 @@
+name: Linter check
+
+on: push
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+  # Make sure CI fails on all warnings, including Clippy lints
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  linter_check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run Fmt
+        run: cargo fmt --all -- --check
+
+      - name: Run Clippy
+        run: cargo clippy --all-targets --all-features
+
+      - name: Check typos
+        uses: crate-ci/typos@master
+      

.github/workflows/ub-detection.yml

@@ -0,0 +1,22 @@
+name: UB (undefined behavior) detection
+
+on: push
+
+env:
+  CARGO_TERM_COLOR: always
+  CARGO_INCREMENTAL: 0
+  # Make sure CI fails on all warnings, including Clippy lints
+  RUSTFLAGS: "-Dwarnings"
+
+jobs:
+  ub-detection:
+    if: github.event.pull_request.draft == false
+    name: Check for undefined behaviour (UB)
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          rustup +nightly component add miri
+          cargo +nightly miri setup
+          MIRIFLAGS="-Zmiri-strict-provenance" cargo +nightly miri test --lib

.gitignore

@@ -0,0 +1,14 @@
+# IDEs
+.vscode
+.idea
+
+# Rust/Cargo
+debug/
+target/
+Cargo.lock
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# These are backup files generated by rustfmt
+**/*.rs.bk