Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (79 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 2.27 KB

Contributing to Bashkit

Thanks for your interest in contributing to Bashkit!

How to Contribute

The easiest and most valuable way to contribute is to create an issue. Bug reports, feature requests, compatibility gaps, and questions all help us prioritize and improve bashkit. A well-described issue is often more impactful than a pull request.

If you'd like to contribute code, read on.

Setup

# Clone
git clone https://github.com/everruns/bashkit.git
cd bashkit

# Install just (task runner)
cargo install just

# Build
just build

# Test
just test

Development Workflow

  1. Fork the repo
  2. Create a feature branch
  3. Make changes
  4. Run pre-PR checks: just pre-pr
  5. Submit a pull request

Commands

just --list       # Show all commands
just build        # Build all crates
just test         # Run all tests
just fmt          # Format code (auto-fix)
just check        # fmt + clippy + test (checks only)
just pre-pr       # Full pre-PR validation

Code Style

  • Format with cargo fmt
  • Lint with cargo clippy -- -D warnings
  • License check: cargo deny check

Commits

Follow Conventional Commits:

feat(parser): add brace expansion support
fix(awk): handle regex in gsub correctly
docs: update compatibility scorecard
test: add array edge case tests

Adding Features

  1. Check if the feature is documented in specs/
  2. Add spec tests in crates/bashkit/tests/spec_cases/
  3. Implement the feature
  4. Update crates/bashkit/docs/compatibility.md if applicable
  5. Update specs/implementation-status.md if removing a limitation

Spec Test Format

Tests live in .test.sh files:

### test_name
# Optional description
echo hello world
### expect
hello world
### end

### skipped_test
### skip: reason for skipping
command
### expect
expected
### end

Pull Request Checklist

  • just pre-pr passes
  • Rebased on main
  • Specs updated if behavior changes
  • CI green

Architecture

See specs/ for design documents:

  • architecture.md - Overall design
  • parser.md - Parser/lexer details
  • vfs.md - Virtual filesystem
  • testing.md - Testing strategy

Questions?

Open an issue at https://github.com/everruns/bashkit/issues