Contributing

​

Setting Up Development Environment

​

Prerequisites

• Rust (latest stable version)
  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  
• Git
  # macOS
  brew install git
  
  # Linux (Debian/Ubuntu)
  sudo apt-get install git
  

​

Clone and Build

1. Fork the repository on GitHub
2. Clone your fork:
   git clone https://github.com/YOUR_USERNAME/cloneit
   cd cloneit
   
3. Build the project:
   cargo build
   
4. Run the development build:
   cargo run -- https://github.com/alok8bb/cloneit/tree/master/src
   

​

Development Workflow

​

Running Tests

cargo test

cargo test -- --nocapture

​

Code Formatting

# Format all code
cargo fmt

# Check formatting without making changes
cargo fmt -- --check

​

Linting

# Run Clippy
cargo clippy

# Run Clippy with all warnings as errors
cargo clippy -- -D warnings

​

Running in Development Mode

# Basic usage
cargo run -- <github_url>

# With zip flag
cargo run -- -z <github_url>

# With custom path
cargo run -- <github_url> /path/to/destination

# Multiple URLs
cargo run -- <url1>,<url2>,<url3>

# Enable debug logging
RUST_LOG=debug cargo run -- <github_url>

​

Coding Standards

​

Rust Style Guidelines

1. Follow Rust conventions: Use cargo fmt to ensure consistent formatting
2. Use meaningful names: Variables, functions, and types should have descriptive names
3. Write documentation: Add doc comments (///) for public APIs
4. Handle errors properly: Use Result types and the ? operator for error propagation
5. Avoid unwrap(): Prefer pattern matching or ? operator for error handling

​

Code Organization

• Keep modules focused on a single responsibility
• Use pub only for items that need to be public
• Group related functionality together
• Add comments for complex logic

​

Example Code Style

/// Downloads a file from GitHub API
/// 
/// # Arguments
/// 
/// * `url` - The GitHub API URL for the file
/// * `path` - The local path to save the file
/// 
/// # Errors
/// 
/// Returns an error if the download fails or file cannot be written
pub async fn download_file(url: &str, path: &Path) -> Result<(), Box<dyn Error>> {
    // Implementation
}

​

Testing Your Changes

​

Manual Testing Checklist

• Download a single file
• Download a directory
• Download a repository root
• Download with -z flag (zipped output)
• Download multiple URLs (comma-separated)
• Download to custom path
• Test with invalid URLs
• Test with non-existent repositories
• Test with private repositories (using GITHUB_TOKEN)

​

Environment Variables

export GITHUB_TOKEN="your_github_token"
cargo run -- <github_url>

​

Submitting Changes

​

Creating a Pull Request

1. Create a feature branch:
   git checkout -b feature/your-feature-name
   
2. Make your changes and commit them:
   git add .
   git commit -m "Add feature: description of your changes"
   
3. Run tests and checks:
   cargo test
   cargo fmt
   cargo clippy
   
4. Push to your fork:
   git push origin feature/your-feature-name
   
5. Open a Pull Request on GitHub:
   • Provide a clear title and description
   • Reference any related issues
   • Explain what your changes do and why

​

Commit Message Guidelines

• Use present tense (“Add feature” not “Added feature”)
• Use imperative mood (“Move cursor to…” not “Moves cursor to…”)
• First line should be a brief summary (50 characters or less)
• Add detailed description if necessary

Add support for downloading gists

Fix issue with recursive directory downloads

Improve error messages for invalid URLs

​

Getting Help

• Issues: Check existing issues on GitHub before creating new ones
• Discussions: Use GitHub Discussions for questions and ideas
• Code Review: Be open to feedback during the PR review process

​

License

MIT License

Copyright (c) 2022 Alok Pawar

​

Code of Conduct

• Be respectful and constructive in discussions
• Welcome newcomers and help them get started
• Focus on what is best for the community
• Show empathy towards other community members

​

Recognition