CONTRIBUTING.md

Contributing to KortexDL

Thank you for your interest in contributing to KortexDL! Contributions from the community are welcome to help make this project better.

Code of Conduct

Please help keep the KortexDL community open and inclusive. Please be kind and respectful to others.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on the GitHub repository. providing the following information:

• A clear, descriptive title
• A description of the issue
• Steps to reproduce the bug
• Expected behavior vs actual behavior
• Your environment (OS, Compiler, Python version, MKL version)

Suggesting Enhancements

Ideas for new features or improvements are welcome. Please open an issue to discuss your idea before implementing it.

Pull Requests

1. Fork the repository and create your branch from main.
2. Set up your environment:
   • Ensure you have Intel oneAPI Base Toolkit installed.
   • Source the setvars script: source /opt/intel/oneapi/setvars.sh
3. Make your changes:
   • Follow the Google C++ Style Guide.
   • Keep Python code compliant with PEP 8.
4. Test your changes:
   • Run C++ tests: cd build && ctest
   • Run Python tests: python -m pytest tests/
5. Submit a Pull Request:
   • Make sure your code compiles and passes tests.
   • Describe your changes clearly in the PR description.
   • Link any related issues.

Development Environment Setup

KortexDL relies heavily on Intel MKL.

1. Install Intel oneAPI Base Toolkit.
2. Set environment variables:

   source ~/intel/oneapi/setvars.sh

Coding Standards

• C++: The project uses Modern C++ (C++17/20). modifying clang-format if available.
• Python: Use snake_case for functions/variables, CamelCase for classes.

Thank you for contributing!