Skip to content

A fast, keyboard-driven TUI API client & webhook inspector. No cloud, no Electron, 100% local-first.

1.5 KB
Raw Blame

Contributing to Ghostman πŸ‘»

Thank you for your interest in contributing to Ghostman! We welcome contributions, bug reports, and ideas from everyone.


πŸ› οΈ Development Setup

  1. Fork and Clone the repository:

    git clone https://github.com/4yk5/Ghostman.git
    cd Ghostman
    
  2. Create a virtual environment (optional but recommended):

    python -m venv venv
    # On Windows:
    venv\Scripts\activate
    # On macOS/Linux:
    source venv/bin/activate
    
  3. Install dependencies:

    pip install -r requirements.txt
    
  4. Run Ghostman locally:

    python main.py
    

πŸ§ͺ Running Tests

Before submitting a Pull Request, always make sure all tests pass cleanly:

python tests/test_all.py

πŸ’‘ How to Contribute

  • Report Bugs: Open an issue using our Bug Report Template.
  • Suggest Features: Have an idea? Submit a Feature Request.
  • Submit Pull Requests:
    1. Fork the repo and create your branch from main (git checkout -b feature/awesome-feature).
    2. Keep code clean, readable, and follow the existing TUI architecture.
    3. Ensure all tests pass.
    4. Submit your Pull Request with a clear description of the changes!

πŸ“„ License

By contributing to Ghostman, you agree that your contributions will be licensed under the MIT License.