Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (73 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

104 lines (73 loc) · 2.37 KB

Contributing to SpotSpoof

Thank you for your interest in contributing to SpotSpoof! This document provides guidelines and instructions for contributing to the project.

This project will only accept PRs to the dev branch.

Getting Started

Prerequisites

Setting Up Your Development Environment

  1. Fork the repository on GitHub

  2. Clone your fork:

git clone https://github.com/YOUR_USERNAME/spotspoof-cli.git
cd spotspoof-cli
  1. Add the upstream remote:
git remote add upstream https://github.com/slimpagey/spotspoof-cli.git
  1. Build the project:
cargo build
  1. Run tests to ensure everything works:
cargo test
  1. Try running the CLI:
cargo run -- --help

Development Workflow

Creating a Feature Branch

Always create a new branch for your work:

# Update your main branch
git checkout dev
git pull upstream dev

# Create a feature branch
git checkout -b feature/your-feature-name

Use descriptive branch names:

  • feature/add-subdomain-detection
  • fix/idn-parsing-error
  • docs/improve-api-examples
  • refactor/cleanup-lookup-logic

Making Changes

  1. Write code following our style guidelines (see below)
  2. Add tests for new functionality
  3. Update documentation if needed (README, code comments, etc.)
  4. Run the test suite:
cargo test
  1. Check code formatting:
cargo fmt
  1. Run the linter:
cargo clippy
  1. Test manually with various inputs to ensure it works as expected

Security Issues

If you discover a security vulnerability, please report it by opening a security issue.

Since SpotSpoof is a public CLI tool that doesn't handle sensitive data, security reports are handled transparently through GitHub issues.

Questions?

If you have questions about contributing:

License

By contributing to SpotSpoof, you agree that your contributions will be licensed under the same license as the project (MIT License).