Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.15 KB

Contributing to DocStripper

First off, thank you for considering contributing to DocStripper! 🎉

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Python version and OS

Suggesting Features

Have an idea? We'd love to hear it! Please create an issue with:

  • Clear description of the feature
  • Use case explanation
  • Proposed implementation (if applicable)

Pull Requests

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

Development Guidelines

  • Follow PEP 8 style guide
  • Add tests for new features
  • Update documentation as needed
  • Keep changes focused and minimal

Code Style

  • Use Python 3.9+ features
  • Prefer standard library over external packages
  • Add docstrings to functions and classes
  • Keep functions small and focused

Thank you for helping make DocStripper better! 🙏