Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (33 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

44 lines (33 loc) · 1.38 KB

Contributing to MiniClick

Thank you for taking the time to improve MiniClick. The project values predictable behavior, local-only operation, 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 interface or behavior change.
  3. Keep changes focused. Avoid unrelated refactors.

Local Environment

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

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

Contribution Guidelines

  • Preserve Windows 10 and Windows 11 compatibility.
  • Do not add telemetry, implicit network communication, or a background service.
  • Keep recordings local and validate loaded input before playback.
  • 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.
  • Run the explicit interaction checks when changing input generation, recording, or target selection.

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.