Compare commits
3 Commits
13d7fce0be
...
docs-forma
Author | SHA1 | Date | |
---|---|---|---|
136da63d00
|
|||
acfec3b97e
|
|||
0b0d4cb982
|
@ -1,44 +0,0 @@
|
|||||||
name: checks
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths: &CODE_PATHS
|
|
||||||
- 'src/**'
|
|
||||||
- 'Cargo*'
|
|
||||||
push:
|
|
||||||
paths: *CODE_PATHS
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
# TODO(cascode) cache checkout for build and test stages?
|
|
||||||
lint:
|
|
||||||
container:
|
|
||||||
# TODO use communitymedia docker registry
|
|
||||||
image: "cascode/aural-isle-ci:0"
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
github-server-url: "https://code.communitymedia.network"
|
|
||||||
- name: rustfmt
|
|
||||||
run: cargo fmt --check
|
|
||||||
build:
|
|
||||||
container:
|
|
||||||
# TODO use communitymedia docker registry
|
|
||||||
image: "cascode/aural-isle-ci:2"
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
github-server-url: "https://code.communitymedia.network"
|
|
||||||
- name: build
|
|
||||||
run: cargo build
|
|
||||||
# TODO(cascode) cache builds for test stage
|
|
||||||
test:
|
|
||||||
container:
|
|
||||||
# TODO use communitymedia docker registry
|
|
||||||
image: "cascode/aural-isle-ci:2"
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
github-server-url: "https://code.communitymedia.network"
|
|
||||||
- name: run unit tests
|
|
||||||
run: cargo test
|
|
30
CONTRIBUTING.md
Normal file
30
CONTRIBUTING.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
# Contribution Guidelines
|
||||||
|
|
||||||
|
## Code Formatting
|
||||||
|
|
||||||
|
We format all Rust code using edition 2021 rules. This edition is defined in our Cargo.toml and most methods below will pick this up automatically.
|
||||||
|
|
||||||
|
### Manual Method
|
||||||
|
|
||||||
|
The most editor agnostic way to format your Rust code is by manually running cargo's fmt sub command.
|
||||||
|
|
||||||
|
To check if your code is formatted without making changes, run `cargo fmt --check`. Then if you want to format your code you can run just `cargo fmt`.
|
||||||
|
|
||||||
|
### VScode
|
||||||
|
|
||||||
|
We recommend the meta extension [Rust Bundle](https://marketplace.visualstudio.com/items?itemName=1YiB.rust-bundle) , which includes rust-analyzer. ([More info](https://code.visualstudio.com/docs/languages/rust) on Rust with VScode) Then to set your editor to format on save:
|
||||||
|
|
||||||
|
* In Visual Studio Code, press Control + Shift + P or Command + Shift + P (Mac) to open the command palette and type setting and then select Preferences: Open User Settings option.
|
||||||
|
* Search for format on save setting and check the checkbox.
|
||||||
|
|
||||||
|
You can also set language specific settings as outlined [here](https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings). You will again want to then search for format on save and check the checkbox.
|
||||||
|
|
||||||
|
### Other Editors
|
||||||
|
|
||||||
|
You will first need to [install rust-analyzer](https://rust-analyzer.github.io/manual.html#installation), then configure your editor and install any needed plugins or extensions as outlined on that page.
|
||||||
|
|
||||||
|
### Pre Commit Hook
|
||||||
|
|
||||||
|
If you want to think about formatting your code less and just have git yell at you whe you try to commit code that is not properly formatted, you can use a simple pre-commit hook.
|
||||||
|
|
||||||
|
After cloning the repo, move the file `pre-commit` to `.git/hooks/pre-commit`. That's it.
|
@ -1,7 +0,0 @@
|
|||||||
FROM rust:1.73-alpine3.18
|
|
||||||
|
|
||||||
#install build tooling
|
|
||||||
RUN apk add musl-dev && rustup component add rustfmt
|
|
||||||
|
|
||||||
# install gitea act_runner dependencies
|
|
||||||
RUN apk add nodejs git
|
|
3
pre-commit
Executable file
3
pre-commit
Executable file
@ -0,0 +1,3 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
cargo fmt --check
|
@ -2,7 +2,8 @@ use warp::Filter;
|
|||||||
|
|
||||||
#[tokio::main]
|
#[tokio::main]
|
||||||
async fn main() {
|
async fn main() {
|
||||||
let hello = warp::get().map(|| format!("Hello world!"));
|
let hello = warp::get()
|
||||||
|
.map(|| format!("Hello world!"));
|
||||||
|
|
||||||
warp::serve(hello).run(([127, 0, 0, 1], 5309)).await;
|
warp::serve(hello).run(([127, 0, 0, 1], 5309)).await;
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user