Skip to content

Commit

Permalink
style: Rename top level folders to lowercase (#138)
Browse files Browse the repository at this point in the history
* Change top level folder names to lower case

* Fix .github and docs

* Change specs/quint and specs/english folder names to lower case

* Fix scripts folder name in .github

---------

Co-authored-by: Romain Ruetschi <romain@informal.systems>
  • Loading branch information
ancazamfir and romac authored Jan 9, 2024
1 parent 03dda99 commit 596781b
Show file tree
Hide file tree
Showing 110 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion .github/codespell/codespell.ini
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[codespell]
skip = ./Code/target
skip = ./code/target
ignore-words = .github/codespell/words.txt
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
version: 2
updates:
- package-ecosystem: "cargo"
directory: "/Code"
directory: "/code"
schedule:
interval: "weekly"
2 changes: 1 addition & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ jobs:
- uses: actions/checkout@v4
- uses: codespell-project/actions-codespell@v2
with:
skip: './Code/target'
skip: './code/target'
ignore_words_file: .github/codespell/words.txt

16 changes: 8 additions & 8 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ on:
push:
branches: main
paths:
- Code/**
- Specs/Quint/**
- code/**
- specs/quint/**
- .github/workflows/coverage.yml
pull_request:
paths:
- Code/**
- Specs/Quint/**
- code/**
- specs/quint/**
- .github/workflows/coverage.yml

jobs:
Expand All @@ -19,7 +19,7 @@ jobs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: Code
working-directory: code
env:
CARGO_TERM_COLOR: always
steps:
Expand All @@ -46,7 +46,7 @@ jobs:
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: Code/lcov.info
files: code/lcov.info
flags: integration
fail_ci_if_error: false

Expand All @@ -55,7 +55,7 @@ jobs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: Code
working-directory: code
env:
CARGO_TERM_COLOR: always
steps:
Expand All @@ -82,6 +82,6 @@ jobs:
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: Code/lcov.info
files: code/lcov.info
flags: mbt
fail_ci_if_error: false
12 changes: 6 additions & 6 deletions .github/workflows/mbt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ on:
branches:
- main
paths:
- Specs/Quint/**
- Code/**
- specs/quint/**
- code/**
- .github/workflows/mbt.yml
pull_request:
paths:
- Specs/Quint/**
- Code/**
- specs/quint/**
- code/**
- .github/workflows/mbt.yml

jobs:
Expand All @@ -36,10 +36,10 @@ jobs:
- name: Install cargo-nextest
uses: taiki-e/install-action@cargo-nextest
- name: Build code
working-directory: Code/itf
working-directory: code/itf
run: cargo nextest run --workspace --all-features --no-run
- name: Current time as random seed for Quint
run: echo "QUINT_SEED=$(date +%s)" >> $GITHUB_ENV
- name: Run tests from traces (with random seed)
working-directory: Code/itf
working-directory: code/itf
run: cargo nextest run -p malachite-itf --all-features
8 changes: 4 additions & 4 deletions .github/workflows/quint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ on:
branches:
- main
paths:
- Specs/Quint/**
- specs/quint/**
pull_request:
paths:
- Specs/Quint/**
- specs/quint/**

name: Quint

Expand All @@ -21,7 +21,7 @@ jobs:
with:
node-version: "18"
- run: npm install -g @informalsystems/quint
- run: bash Scripts/quint-forall.sh typecheck Specs/Quint/**/*.qnt
- run: bash scripts/quint-forall.sh typecheck specs/quint/**/*.qnt

quint-test:
name: Test
Expand All @@ -34,4 +34,4 @@ jobs:
with:
node-version: "18"
- run: npm install -g @informalsystems/quint
- run: bash Scripts/quint-forall.sh "test --max-samples $MAX_SAMPLES" Specs/Quint/tests/**/*Test.qnt
- run: bash scripts/quint-forall.sh "test --max-samples $MAX_SAMPLES" specs/quint/tests/**/*Test.qnt
14 changes: 7 additions & 7 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ on:
push:
branches: main
paths:
- Code/**
- Specs/Quint/**
- code/**
- specs/quint/**
- .github/workflows/rust.yml
pull_request:
paths:
- Code/**
- Specs/Quint/**
- code/**
- specs/quint/**
- .github/workflows/rust.yml

env:
Expand All @@ -27,7 +27,7 @@ jobs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: Code
working-directory: code
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down Expand Up @@ -58,7 +58,7 @@ jobs:
uses: actions-rs/clippy@master
with:
token: ${{secrets.GITHUB_TOKEN}}
args: --all-features --all-targets --manifest-path Code/Cargo.toml
args: --all-features --all-targets --manifest-path code/Cargo.toml

fmt:
name: Formatting
Expand All @@ -73,4 +73,4 @@ jobs:
- name: Check formatting
uses: actions-rust-lang/rustfmt@v1
with:
manifest-path: Code/Cargo.toml
manifest-path: code/Cargo.toml
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Tendermint consensus in Rust

The repository is split in three areas, each covering one of the important areas of this project:

1. [Code](./Code): Comprises the Rust implementation of the Tendermint consensus algorithm, split across multiple Rust crates.
2. [Docs](./Docs): Comprises Architectural Decision Records (ADRs) and other documentation, such as the 2018 paper describing the core consensus algorithm.
3. [Specs](./Specs): English and [Quint][quint-repo] specifications.
1. [code](./code): Comprises the Rust implementation of the Tendermint consensus algorithm, split across multiple Rust crates.
2. [docs](./docs): Comprises Architectural Decision Records (ADRs) and other documentation, such as the 2018 paper describing the core consensus algorithm.
3. [specs](./specs): English and [Quint][quint-repo] specifications.

## Requirements

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion Code/itf/src/utils.rs → code/itf/src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ pub fn generate_traces(spec_rel_path: &str, gen_dir: &str, quint_seed: u64) {
println!("🪄 Generating traces for {spec_rel_path:?}...");

let spec_abs_path = format!(
"{}/../../Specs/Quint/{}",
"{}/../../specs/quint/{}",
env!("CARGO_MANIFEST_DIR"),
spec_rel_path
);
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ codecov:
require_ci_to_pass: yes

# ignore:
# - "Code/itf"
# - "Code/test"
# - "code/itf"
# - "code/test"

coverage:
precision: 2
Expand All @@ -17,13 +17,13 @@ coverage:
threshold: 5%
removed_code_behavior: adjust_base
paths:
- "Code"
- "code"
patch:
default:
target: auto
threshold: 5%
paths:
- "Code"
- "code"

changes:
default:
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Context

This ADR provides architecture and design recommendations for the implementation of the Tendermint consensus protocol in Rust. The implementation follows the article ["The latest gossip on BFT consensus"](#References) and the English and Quint specifications located in the [Specs](../../Specs) directory.
This ADR provides architecture and design recommendations for the implementation of the Tendermint consensus protocol in Rust. The implementation follows the article ["The latest gossip on BFT consensus"](#References) and the English and Quint specifications located in the [specs](../../specs) directory.

### Terminology

Expand All @@ -19,9 +19,9 @@ We use terminology in line with [prior art on Tendermint and BFT consensus](http
### Repository Overview

The repository is split in three areas, each covering one of the important areas of this project:
1. [Code](../../Code): Comprises the Rust implementation of the Tendermint consensus algorithm, split across multiple Rust crates.
2. [Docs](../../Docs): Comprises Architectural Decision Records (ADRs) such as the present file and other documentation.
3. [Specs](../../Specs): English and Quint specifications.
1. [code](../../code): Comprises the Rust implementation of the Tendermint consensus algorithm, split across multiple Rust crates.
2. [docs](../../docs): Comprises Architectural Decision Records (ADRs) such as the present file and other documentation.
3. [specs](../../specs): English and Quint specifications.

### Overview of the Tendermint Consensus Implementation

Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion Specs/English/README.md → specs/english/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ least `f + 1`, which is strictly greater than `f`.

## Consensus protocol - round state machine

This document provides an overview of the Tendermint consensus protocol and follows ["The latest gossip on BFT consensus"](#References) and the English and Quint specifications located in the [Specs](../../Specs) directory.
This document provides an overview of the Tendermint consensus protocol and follows ["The latest gossip on BFT consensus"](#References) and the English and Quint specifications located in the [specs](../../specs) directory.

The consensus state-machine operates on complex `Event`s that reflect the
reception of one or multiple `Message`s, combined with state elements and the
Expand Down
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 596781b

Please sign in to comment.