Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
115 lines (81 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

115 lines (81 loc) · 2.81 KB

Contributing to pentestkit

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

Code of Conduct

By participating in this project, you agree to uphold our Code of Conduct:

  • Use welcoming and inclusive language
  • Be respectful of differing viewpoints and experiences
  • Gracefully accept constructive criticism
  • Focus on what is best for the community
  • Show empathy towards other community members

How to Contribute

Reporting Bugs

  1. Check existing issues - Search through the issues to see if the bug has already been reported.
  2. Create a new issue - If the bug is new, create an issue using the bug report template.
  3. Provide detailed information - Include:
    • A clear description of the bug
    • Steps to reproduce
    • Expected vs. actual behavior
    • Screenshots if applicable
    • Environment details (OS, Python version, etc.)

Suggesting Enhancements

  1. Check existing issues - Make sure the enhancement has not already been suggested.
  2. Create a new issue - Use the feature request template.
  3. Describe the enhancement - Provide a clear description of what you want to happen and why it would be valuable.

Pull Requests

  1. Fork the repository
  2. Create a feature branch - git checkout -b feature/your-feature-name
  3. Make your changes
  4. Add tests - New features and bug fixes should include tests
  5. Ensure all tests pass - Run pytest
  6. Update documentation - Make sure any new functionality is documented
  7. Create a pull request - Use the pull request template

Development Setup

Prerequisites

  • Python 3.8 or higher
  • pip
  • virtualenv or venv (recommended)

Installation for Development

  1. Fork and clone the repository:

    git clone https://github.com/rahulkaushal04/pentestkit.git

  2. Create and activate a virtual environment:

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install development dependencies:

    pip install -r requirements.txt

Running Tests

pytest

For a specific test:

pytest tests/test_parser.py

With coverage:

pytest --cov=pentestkit

Project Structure

pentestkit/
│── src/
│ ├── pentestkit/
│ │ ├── dataclasses/
│ │ ├── fuzzer/
│ │ ├── parser/
│ │ ├── cli.py
│ │ ├── utils.py/
│ ├── tests/
│── docs/

License

By contributing to pentestkit, you agree that your contributions will be licensed under the project's license.

Contact

If you have questions or need help, please:

  • Open an issue

Thank you for contributing to make pentestkit better!