Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1.02 KB

Contributing to Steel

Getting Started

The following will clone Steel from the primary repository and run the test suite. You should have previously setup a recent rust tool chain.

git clone https://github.com/mattwparas/steel.git &&
cd steel &&
mkdir -p .steel/cogs &&
export STEEL_HOME="$(pwd)/.steel" &&
cargo build &&
pushd cogs &&
cargo run -- install.scm &&
popd &&
cargo test --all

Commit message style

Steel does not employ a strict commit message style or convention. Try to follow best practices by keeping the first line concise and descriptive, otherwise use your best judgement.

Submitting Patches

IMPORTANT: By submitting a patch, you agree that your work will be licensed under the license used by the project.

Follow common advice when submitting a patch:

  • Keep the patch focused.
  • Include tests.
  • Work in a separate branch, not master.
  • Before working on "big ideas", open an issue to discuss approaches or requirements to limit wasted effort.