Contributing

Thank you for your interest in contributing to JWT-HACK! This project welcomes contributions from the community.

Getting Started

Prerequisites

Rust and Cargo installed (latest stable version recommended)
Git
Just task runner (optional but recommended)

Development Setup

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/YOUR-USERNAME/jwt-hack.git
cd jwt-hack

Create a branch for your work:

git checkout -b features/your-feature-name
# or
git checkout -b bugfix/issue-description

Building and Testing

Install Just task runner for easier development:

cargo install just

Development workflow:

# Build for development (takes ~75s first time, ~18s subsequent)
just dev

# Run all tests (takes ~17s)
just test

# Format and fix linting issues
just fix

# Clean build
cargo clean && just dev

Code Guidelines

Rust Code Style

Follow the Rust API Guidelines
Use cargo fmt to format your code before committing
Run cargo clippy and address any warnings
Write comprehensive tests for new functionality

Commit Messages

Use clear, concise commit messages
Start with a verb in the present tense (e.g., "Add feature" not "Added feature")
Reference issue numbers when applicable (e.g., "Fix #123: Memory leak in URL parser")

Testing Requirements

All contributions must include appropriate tests:

# Unit tests
cargo test

# Integration tests
cargo test --test integration

# Linting
cargo clippy -- --deny warnings

# Formatting check
cargo fmt --check

Pull Request Process

Before Submitting

Ensure your code builds without errors:
```
just dev
```
Run the full test suite:
```
just test
```
Update documentation if needed

Verify functionality with manual testing:

./target/debug/jwt-hack --help
./target/debug/jwt-hack decode <test-token>

For more detailed contributing guidelines, please see the full CONTRIBUTING.md in the repository.