Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (67 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

98 lines (67 loc) · 2.98 KB
Raw

Contributing

Project structure

This project is structured in 3 parts:

  • rust/rubydex: the Rust crate implementing all of the core logic for statically analyzing Ruby code
  • rust/rubydex-sys: the Rust crate for FFI bindings that allow using the main crate from C code
  • the top level of the repository is a Ruby gem with a native extension, which uses C code to link against the Rust crate and provide a Ruby API for the Rust backed implementation

Architecture, concepts and analysis

To understand how the analysis is structured, please see the architecture docs. We also have documentation for Ruby concepts and behavior.

Practical development tips

In general, we strive for consistency in our development environments and techniques. For example, recommended extensions and settings for VS Code are already provided in the .vscode directory.

Instructions for AI models and agents are in the agents file.

Rust

The rust directory is a worskpace, where all common cargo commands can be used to build, lint or run tests.

  • Testing: cargo test
  • Linting: cargo clippy
  • Formatting: rustfmt
  • Compiling: cargo build

With the recommended extensions, it's possible to use Rust Analyzer's debug code lens actions to interactively debug tests through VS Code.

We try to be on the latest version of Rust and CI always runs against the latest.

Ruby

  • Compiling: bundle exec rake compile (triggers the compilation of the Rust crates too)
  • Testing: bundle exec rake ruby_test
  • Linting: bundle exec rubocop
  • Formatting: bundle exec rubocop -a

Releasing

Releases are cut by maintainers from main. The repository uses shopify/cibuildgem to build and publish precompiled gems, so do not run rake release locally.

To cut a new release:

  1. Check out main and make sure it is current:

    git checkout main
git pull --ff-only

  2. Bump the gem version in lib/rubydex/version.rb.

  3. Refresh Gemfile.lock so the local rubydex spec version matches:

    bundle lock --local

  4. Run the local validation suite:

    bundle exec rake check
bundle exec rake compile_release

    compile_release builds with RELEASE=true, which verifies the packaging path for the precompiled native extension, the rubydex_mcp binary, and bundled third-party license output.

  5. Commit the version bump directly on main:

    git add lib/rubydex/version.rb Gemfile.lock
git commit -m "Bump version to vX.Y.Z"
git push origin main

  6. Tag the same commit and push the tag:

    git tag vX.Y.Z
git push origin vX.Y.Z

Pushing a tag matching vX.Y.Z or vX.Y.Z.betaN triggers the release workflow in .github/workflows/cibuildgem.yaml. That workflow cross-compiles the precompiled gems, runs install verification, publishes to RubyGems, and creates the GitHub release. Workflow dispatch can be used for a dry run; only tag pushes publish a release.