Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

81 lines (57 loc) · 1.68 KB

Contributing to AmzPy

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

Development Setup

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/theonlyanil/amzpy.git
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies:
pip install -e ".[dev]"

Code Style

  • Follow PEP 8 guidelines
  • Use type hints for all function parameters and return values
  • Add docstrings for all public functions and classes
  • Keep code modular and maintainable

Adding New Features

  1. Create a new branch for your feature:
git checkout -b feature/your-feature-name
  1. Implement your changes
  2. Add tests for new functionality
  3. Update documentation if needed
  4. Run tests locally:
pytest

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the requirements.txt if you add new dependencies
  3. Create a Pull Request with a clear description of the changes
  4. Wait for review and address any feedback

Feature Suggestions

  • Add support for more product details (ratings, reviews, etc.)
  • Implement async support
  • Add proxy support
  • Create CLI interface
  • Add support for product variants
  • Implement caching mechanism

Reporting Issues

When reporting issues, please include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Python version and OS information

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Help maintain a positive community