Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 1.59 KB

File metadata and controls

66 lines (48 loc) · 1.59 KB

Contributing to Email Scraping

Thank you for your interest in contributing to this educational project!

Educational Purpose

This project is designed for educational purposes to help students and developers learn about:

  • Web scraping techniques
  • Email extraction and validation
  • TypeScript/Node.js development
  • Python automation
  • Data processing pipelines

Code of Conduct

  • Be respectful and inclusive
  • Focus on educational value
  • Follow ethical web scraping practices
  • Respect robots.txt and website terms of service
  • Never use this project for spam or harassment

How to Contribute

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes following the project's coding standards
  4. Test your changes thoroughly
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Install dependencies
npm install

# Run tests
npm test

# Run linter
npm run lint

# Build the project
npm run build

Coding Standards

  • Use TypeScript for new features
  • Follow ESLint and Prettier configurations
  • Write clear, educational comments
  • Add tests for new functionality
  • Update documentation as needed

Reporting Issues

When reporting issues, please include:

  • Description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment details (Node.js version, OS, etc.)

Questions?

Feel free to open an issue for questions or discussions about the project.