Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.32 KB
Raw

Contributing to DelayEdge

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

How to Contribute

Reporting Bugs

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

  • A clear description of the problem
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Your Python version and operating system
  • Any relevant error messages or logs

Suggesting Features

Feature suggestions are welcome! Please open an issue describing:

  • The feature you'd like to see
  • Why it would be useful
  • How it might work

Pull Requests

  1. Fork the repository and create a new branch for your changes
  2. Make your changes following the code style
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Submit a pull request with a clear description of your changes

Code Style

  • Follow PEP 8 Python style guidelines
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions focused and modular

Testing

Before submitting a pull request:

  • Test your changes in test mode (--test flag)
  • Verify the code runs without errors
  • Check that existing functionality still works

Questions?

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

Thank you for contributing!