Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (90 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

120 lines (90 loc) · 3.17 KB
Raw

Contributing to EDUSRC Hunter

Thank you for your interest in contributing to EDUSRC Hunter! This document provides guidelines and information about contributing to this project.

How to Contribute

1. Reporting Issues

If you find a bug or have a feature request, please create an issue with:

  • Clear description of the problem or suggestion
  • Steps to reproduce (for bugs)
  • Expected behavior vs actual behavior
  • Environment information (OS, tool versions, etc.)

2. Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Create a Pull Request

3. Development Guidelines

Code Style

  • Follow existing code patterns
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and concise

Documentation

  • Update README.md for new features
  • Add entries to CHANGELOG.md
  • Update QUICKSTART.md if needed
  • Include code examples where appropriate

Testing

  • Test your changes thoroughly
  • Verify compatibility with different environments
  • Ensure no regression in existing functionality
  • Test with real edu.SRC targets (when possible)

4. Contribution Areas

We welcome contributions in the following areas:

Core Features

  • New vulnerability detection methods
  • Improved information gathering techniques
  • Better report generation
  • Performance optimizations

Documentation

  • Tutorials and guides
  • Code examples
  • Best practices
  • FAQ updates

Tools Integration

  • New Burp MCP integrations
  • Additional security tools
  • Automation scripts
  • Analysis utilities

5. Code Review Process

All contributions will be reviewed for:

  • Correctness: Does the code work as intended?
  • Quality: Is the code clean and maintainable?
  • Security: Are there any security concerns?
  • Documentation: Is it properly documented?
  • Compatibility: Does it work across different environments?

6. Issue Labels

  • bug: Something isn't working
  • enhancement: New feature or request
  • documentation: Documentation improvements
  • good first issue: Good for newcomers
  • help wanted: Extra attention is needed
  • question: Further information is requested

7. Community Guidelines

  • Be respectful and inclusive
  • Help others when possible
  • Share knowledge and experience
  • Follow the code of conduct

Getting Started

Prerequisites

  • Claude Code CLI
  • Burp Suite Professional (for Burp MCP features)
  • Basic understanding of web security
  • Familiarity with edu.SRC platform

Development Setup

  1. Clone the repository
  2. Install dependencies (if any)
  3. Configure your development environment
  4. Start contributing!

First Contribution Ideas

  • Fix a typo in documentation
  • Add a new payload to the database
  • Improve error handling
  • Add unit tests
  • Create a tutorial

Questions?

If you have questions about contributing, feel free to:

  • Open an issue with the question label
  • Contact the maintainers
  • Join the community discussions

Thank you for contributing to EDUSRC Hunter!