Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (39 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

61 lines (39 loc) · 1.56 KB
Raw

Contributing to CodeSleuth

Bug reports, feature requests, and pull requests are accepted.

How to contribute

  • Issues: include how to reproduce bugs.
  • Pull requests: branch from main, pass tests and lints, describe the change.

Coding style

Use descriptive names. Comment non-obvious logic.

Commit messages

Present tense. Short summary, then detail if needed. Reference issues when relevant (Fixes #12).

Contact

Open an issue or email Cody Marsengill at cod.e.codes.dev@gmail.com.

Setup

  1. Rust 1.85+: https://rustup.rs/
  2. Clone and build:
git clone https://github.com/Cod-e-Codes/codesleuth.git
cd codesleuth
cargo build --release

Tests

cargo test
cargo clippy --all-targets -- -D warnings
cargo fmt --check

Product path on local public COBOL (not dummy files):

./target/release/codesleuth analyze test-cobol --workers 4 --output reports-verify
./target/release/codesleuth analyze test-cobol --workers 4 --benchmark

test-cobol/ is gitignored. The COBOL Programming Course labs are CC-BY-4.0; IBM Z Open Editor samples in that tree keep their upstream licenses.

Load-test files only:

cargo run --bin gen_dummy -- --count=1000 --outdir=dummy-cobol

Before committing

  • cargo fmt and cargo clippy --all-targets -- -D warnings