Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (48 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

64 lines (48 loc) · 1.52 KB
Raw

Contributing to News Agent

Thank you for your interest in contributing to News Agent!

How to Contribute

  1. Fork the repository
  2. Create a new branch for your feature/fix: 
    git checkout -b feature/your-feature-name
  3. Make your changes
  4. Commit your changes: 
    git commit -m "Description of your changes"
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Create a Pull Request

Development Setup

  1. Clone the repository: 
    git clone https://github.com/dhruvldrp9/NewsAgent.git
cd NewsAgent
  2. Set up environment variables
  3. Install dependencies: pip install -r requirements.txt
  4. Run the application: python app.py

Code Style

  • Follow PEP 8 for Python code
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Write docstrings for functions and classes

Testing

  • Test both text and voice features
  • Verify authentication functionality
  • Check news fetching and summarization
  • Test on different browsers and devices

Pull Request Process

  1. Update documentation if needed
  2. Ensure all functionality works properly
  3. Test both text and voice features
  4. Get approval from maintainers

Questions?

Contact: dhruv.ldrp9@gmail.com

Links