Thank you for considering contributing to Image Extender! This document outlines the process for contributing to the project.
By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to the project maintainer.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue with your suggestion, clearly describing the enhancement and the motivation for it.
- Provide specific examples to demonstrate the steps to realize the enhancement. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests to ensure no functionality is broken
- Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- CUDA-compatible GPU
- CUDA 12.x and cuDNN installed
- CMake 3.18+
- vcpkg package manager
- Install the required dependencies as mentioned in the README.md.
- Clone your fork of the repository locally.
- Set up vcpkg and install the dependencies.
- Build with CMake as described in the README.md.
- Follow the existing code style in the project
- Write clear, maintainable code
- Document your code with comments where necessary
- Write unit tests for new functionality
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
By contributing, you agree that your contributions will be licensed under the project's MIT License.