Skip to content

Commit

Permalink
Set up the repository
Browse files Browse the repository at this point in the history
This commit performs initial repository setup, including adding a
README, basic project structure, CI, and other necessary things.
  • Loading branch information
iamrecursion committed Sep 3, 2024
0 parents commit 374b4a8
Show file tree
Hide file tree
Showing 15 changed files with 782 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# General Code
* @reilabs/starkware
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Bug report
about: Found something wrong? Let us know.
title: "[BUG] "
labels: bug
assignees: ''
---

# Describe the Bug

A clear and concise description of what the bug is.

# To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

# Expected Behaviour

A clear and concise description of what you expected to happen.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Feature
about: A new feature to be added.
title: "[FEAT] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Performance
about: An opportunity for performance improvement or other performance-related work.
title: "[PERF] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Task
about: A development task to be done.
title: "[TASK] "
labels: enhancement
assignees: ''
---

# Description

What is this about?

# Spec

Give details.
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Summary

<!-- What is this PR about? -->

# Details

<!-- What do you want the reviewers to focus on? Anything important that they should know? -->

# Checklist

- [ ] Code is formatted by Rustfmt.
- [ ] Documentation has been updated if necessary.
128 changes: 128 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Metadata for the actions workflow
name: CI
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "*" ]

# Environment variables that will be set on all runners
env:
RUST_VERSION: 1.81.0 # Should agree with Cargo.toml
CARGO_TERM_COLOR: always # Always colour Cargo's output.
CARGO_INCREMENTAL: 0 # Always run without incremental builds on CI.
CARGO_PROFILE_DEV_DEBUG: 0 # Don't embed debug info even though the build is a dev build.

# Configuration for individual jobs
jobs:
# This job is responsible for running the unit and integration tests.
test:
name: "Test"
strategy:
fail-fast: false
matrix:
os: [ "ubuntu-latest", "macos-latest" ]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Install rust
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ env.RUST_VERSION }}
override: true
- name: Restore Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ env.RUST_VERSION }}-cargo-test-${{ hashFiles('**/Cargo.lock') }}
restore-keys: ${{ env.RUST_VERSION }}-cargo-test-
- name: Build Tests
uses: actions-rs/cargo@v1
with:
command: test
args: --all-targets --no-run
# Unfortunately `--all-targets` doesn't handle the doctests. See <https://github.com/rust-lang/cargo/issues/6669>.
# To that end, we build them separately and just pass `--help` to prevent them running in this step.
- name: Build Doctests
uses: actions-rs/cargo@v1
with:
command: test
args: --doc -- --help
- name: Run Tests
uses: actions-rs/cargo@v1
with:
command: test
args: --all-targets -- --nocapture
- name: Run Doctests
uses: actions-rs/cargo@v1
with:
command: test
args: --doc -- --nocapture

# This job runs the linter and puts any lint results inline in the PR for easy visibility.
lint:
name: "Lint"
runs-on: "ubuntu-latest"
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Install rust
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: ${{ env.RUST_VERSION }}
override: true
components: clippy
- name: Restore Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ env.RUST_VERSION }}-cargo-test-${{ hashFiles('**/Cargo.lock') }}
restore-keys: ${{ env.RUST_VERSION }}-cargo-test-
- name: Lint Code
uses: actions-rs/clippy-check@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
args: --all-targets

formatting:
name: "Check Formatting"
runs-on: "ubuntu-latest"
steps:
- name: Checkout Code
uses: actions/checkout@v3
- name: Install rust
uses: actions-rs/toolchain@v1
with:
toolchain: nightly
profile: minimal
override: true
components: rustfmt
- name: Restore Cache
uses: actions/cache@v3
continue-on-error: true
with:
path: |
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ env.RUST_VERSION }}-cargo-test-${{ hashFiles('**/Cargo.lock') }}
restore-keys: ${{ env.RUST_VERSION }}-cargo-test-
- name: Check Formatting
uses: actions-rs/cargo@v1
with:
command: fmt
args: --all -- --check
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Rust
/target

# Tooling
.idea/
Loading

0 comments on commit 374b4a8

Please sign in to comment.