Hammerspoon/hammerspoon

Add Sample Mixed Lua/Objective-C Extension to Contribution Guide

Open

#1345 opened on Apr 19, 2017

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Objective-C (15,415 stars) (688 forks)batch import
docsenhancementhelp wanted

Description

It would be great if someone ( @cmsj or @asmagill ?) could add a very bare, plain, simple and well documented Mixed Lua/Objective-C Extension to the Contribution Guide.

Contributor guide

Tech stack
luaobjective c
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Lua basicsObjective C basicsHammerspoon extension structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the existing Contribution Guide in the Hammerspoon repository. Examine examples of mixed Lua/Objective C extensions in other parts of the codebase (e.g., internal extensions). Create a minimal example with a Lua module that calls an Objective C class, include comments explaining the bridging process. Add the example under a new section in the guide, referencing the developers @cmsj or @asmagill for clarification if needed.