Removed useless files
parent
e6599fdf7b
commit
ce23d12a99
@ -1,27 +0,0 @@
|
|||||||
image: "rust:latest"
|
|
||||||
|
|
||||||
default:
|
|
||||||
before_script:
|
|
||||||
- rustc --version
|
|
||||||
- cargo --version
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- test
|
|
||||||
|
|
||||||
lint-code:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- rustup component add clippy
|
|
||||||
- cargo clippy -- -D warnings
|
|
||||||
|
|
||||||
format-code:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- rustup component add rustfmt
|
|
||||||
- cargo fmt -- --check
|
|
||||||
|
|
||||||
audit-code:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- cargo install cargo-audit
|
|
||||||
- cargo audit
|
|
@ -1,28 +0,0 @@
|
|||||||
# Crystal Linux Contributing Guidelines
|
|
||||||
|
|
||||||
#### !! Always make sure to `git pull` before doing any work to avoid commit hell !!
|
|
||||||
|
|
||||||
### Pre-Commit Checks
|
|
||||||
|
|
||||||
- Make sure to `cargo fmt` your code before every commit push
|
|
||||||
- Unless in specific edge cases, don't push code that doesn't pass `cargo check`
|
|
||||||
- Try to correct any code with `cargo clippy` before you push
|
|
||||||
|
|
||||||
### Formatting
|
|
||||||
|
|
||||||
- UNIX line endings (LF instead of CRLF)
|
|
||||||
- 4 spaces per TAB
|
|
||||||
|
|
||||||
### Good Practices
|
|
||||||
|
|
||||||
- Try to use .unwrap() as little as possible
|
|
||||||
- Try to never use panic!() in production code, always try to have a possible way to resolve errors, even if it's just
|
|
||||||
unwrap_or/_else()
|
|
||||||
- Never use println!() or eprintln!() in finalised code. Using string functions (e.g. info() in Amethyst v3.0.0) is
|
|
||||||
preferred
|
|
||||||
- Compartmentalise as much as you can, avoid writing the exact same line of code 50 times if you can turn it into a
|
|
||||||
function
|
|
||||||
|
|
||||||
### Examples of these guidelines in practice
|
|
||||||
|
|
||||||
- https://git.getcryst.al/crystal/ame/src/branch/rewrite
|
|
Loading…
Reference in New Issue