Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (32 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 1.33 KB

Contributing to MiniSnip

Thank you for taking the time to improve MiniSnip. The project values predictable behavior, low resource usage, and changes that remain easy to audit.

Before You Start

  1. Search for an existing issue before creating a new one.
  2. Open an issue first when proposing a significant user interface or behavior change.
  3. Keep changes focused. Avoid unrelated refactors.

Local Environment

MiniSnip builds on Windows with .NET Framework 4.x:

git clone https://github.com/Mirochill/MiniSnip.git
cd MiniSnip
.\build.ps1
.\test.ps1

Contribution Guidelines

  • Preserve Windows 10 and Windows 11 compatibility.
  • Do not add telemetry or implicit network communication.
  • Keep screenshots local and clipboard-based.
  • Avoid third-party dependencies when a Windows or .NET Framework API is sufficient.
  • Add or update tests when behavior changes.
  • Run .\build.ps1 and .\test.ps1 before opening a pull request.
  • Measure the impact of changes to performance-sensitive paths, especially overlay painting and mouse event handling.

Pull Requests

Describe the problem, the selected approach, and the checks you ran. Include before-and-after screenshots when intentionally modifying the interface.

By submitting a contribution, you agree that it will be distributed under the project's MIT License.