Contributing

We welcome contributions to SignXAI! This document provides guidelines for contributing to the project.

How to Contribute

  1. Fork the Repository: Start by forking the SignXAI repository on GitHub.

  2. Clone Your Fork: Clone your fork to your local machine.

  3. Create a Branch: Create a new branch for your feature or bug fix.

  4. Make Your Changes: Implement your changes, following the coding standards below.

  5. Test Your Changes: Ensure all tests pass and add new tests for new functionality.

  6. Submit a Pull Request: Push your changes to your fork and submit a pull request.

Coding Standards

  • Follow PEP 8 for Python code style

  • Write clear, self-documenting code with appropriate comments

  • Ensure all public functions have docstrings

  • Maintain consistency with existing code patterns

Testing

  • Write unit tests for new functionality

  • Ensure all existing tests pass

  • Test with both TensorFlow and PyTorch frameworks

Documentation

  • Update relevant documentation for any API changes

  • Add examples for new features

  • Keep docstrings up to date

Issue Reporting

  • Use GitHub Issues to report bugs or request features

  • Provide minimal reproducible examples

  • Include system information (OS, Python version, framework versions)