Contributing to Img2Num

First off, thank you for considering contributing to Img2Num! We welcome any kind of contribution—bug reports, feature requests, documentation improvements, code fixes, or optimizations. This document outlines the process for contributing, from setting up your development environment to submitting pull requests.

Code of Conduct

Please review and adhere to our Code of Conduct to help foster an open and welcoming environment.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue at: https://github.com/Ryan-Millard/Img2Num/issues

When reporting issues, please:

• Use a descriptive title.
• Include steps to reproduce, expected behavior, and actual behavior.
• Attach screenshots or logs if applicable.
• Specify your environment (OS, Node.js version, browser).

Development Setup

The Getting Started section shows how to clone and run the application for the first time.

The Project Scripts section shows all of the available scripts you may find useful whilst working on Img2Num's source code as well as a helful way to find specific scripts if you have forgotten one.

Additional Resources

• README
• Orchestrator Makefile
• Vite Config
• ESLint Config

Thank you for improving Img2Num! 🎨🚀