Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (103 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

136 lines (103 loc) · 3.26 KB

Contributing to Android ADB Automation Tools

First off, thank you for considering contributing to this project! Below are the guidelines for contributing.

Code of Conduct

This project adheres to a code of conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues list. When you create a bug report, include:

  • Your operating system name and version
  • Python version
  • ADB version
  • Detailed steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Relevant logs or screenshots

Use this template for bug reports:

### Bug Description
[Clear and concise description of what the bug is]

### To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Run command '....'
3. See error

### Expected Behavior
[What you expected to happen]

### Actual Behavior
[What actually happened]

### Environment
- OS: [e.g. macOS 12.0]
- Python Version: [e.g. 3.9.0]
- ADB Version: [e.g. 1.0.41]

Suggesting Enhancements

For enhancement suggestions, please:

  • Use a clear and descriptive title
  • Provide a detailed description of the proposed functionality
  • Include examples of how the feature would be used
  • Explain why this enhancement would be useful

Pull Requests

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Follow the coding standards:
    • Use snake_case for Python files and functions
    • Include docstrings for all functions
    • Add type hints where applicable
    • Follow PEP 8 guidelines
  4. Add tests for new functionality
  5. Update documentation as needed
  6. Commit your changes (git commit -m 'Add some amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Pull Request Template

### Description
[Describe your changes in detail]

### Related Issue
Fixes #[issue number]

### Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Other (please describe)

### Testing
- [ ] Added new tests
- [ ] All tests pass locally
- [ ] Tested on Android device (specify model/OS version)

### Screenshots
[If applicable, add screenshots]

Development Setup

# Clone your fork
git clone https://github.com/your-username/androidpentest.git

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On macOS/Linux
.\venv\Scripts\activate   # On Windows

# Install dependencies
pip install -r requirements.txt

# Install development dependencies
pip install -r requirements-dev.txt

Running Tests

# Run all tests
pytest

# Run specific test file
pytest tests/test_specific_file.py

# Run with coverage report
pytest --cov=.

Style Guide

  • Use Black for code formatting
  • Use isort for import sorting
  • Use flake8 for linting

Documentation

  • Add docstrings to all functions following Google style
  • Update README.md if adding new features
  • Include examples in documentation

Questions?

Feel free to open an issue with the "question" label if you need help.

License

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