Contributing

Thanks for your interest in contributing to FindeRS! This is a personal project that grew into my daily command-line companion, and I’m happy to have others involved.

Getting Started

FindeRS is written in Rust. You’ll need:

Rust 1.70 or later (rustup update)
Git
A GitHub account (for pull requests)

Clone and build:

git clone https://github.com/ydkadri/finders.git
cd finders
cargo build
cargo test

Areas for Contribution

I’m particularly interested in:

Bug fixes - If something doesn’t work as documented, please fix it!
Documentation - Improvements to examples, clarifications, typo fixes
Performance - Benchmarks, profiling, optimization ideas
Testing - More test cases, especially edge cases
Examples - Real-world usage patterns and integration examples

Before You Start

For anything beyond typos and documentation:

Open an issue first to discuss the change
Wait for feedback before investing significant time
Keep changes focused and atomic

This helps ensure your effort aligns with the project direction.

Development Workflow

Making Changes

Fork the repository
Create a feature branch (git checkout -b fix/your-fix)
Make your changes
Write or update tests
Run the checks (see below)
Commit with clear messages
Push and open a pull request

Quality Checks

Before submitting:

# Format code
cargo fmt

# Lint
cargo clippy -- -D warnings

# Test
cargo test

# Benchmarks (if you changed performance-sensitive code)
cargo bench

All checks must pass before your PR can be merged.

Writing Tests

Add unit tests in the same file as the code
Add integration tests in tests/ for end-to-end scenarios
Test both happy paths and error cases

Example:

#![allow(unused)]
fn main() {
#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_your_feature() {
        // Arrange
        let input = setup_test_data();
        
        // Act
        let result = your_function(input);
        
        // Assert
        assert_eq!(result, expected);
    }
}
}

Commit Messages

Keep them clear and descriptive:

Fix regex escaping in file patterns

Filenames with dots were incorrectly treated as regex
metacharacters. Now properly escape special characters
before compiling regex patterns.

Fixes #42