GitHub: contributing to the AutoHotkey source code

Discuss Autohotkey related topics here. Not a place to share code.
Forum rules
Discuss Autohotkey related topics here. Not a place to share code.
User avatar
Posts: 6904
Joined: 19 Dec 2016, 01:58
Location: UK

GitHub: contributing to the AutoHotkey source code

27 Nov 2019, 06:50

This thread is for people to post advice/guidelines re. contributing pull requests to the AutoHotkey source code.

[AHK v1.1/v2.0 source code]
Commits · Lexikos/AutoHotkey_L · GitHub
Commits · Lexikos/AutoHotkey_L · GitHub

Style Guide

C++ style guide:
Allman style indentation
snake_case for variable names
UpperCamelCase for function names

v2: Make OnExit/OnClipboardChange accept a function by fincs · Pull Request #27 · Lexikos/AutoHotkey_L · GitHub
Please try to match the style and conventions used in the existing code. For instance, avoid using a naming prefix to indicate the type of variable (like bEnable). I try to follow the conventions established by Chris - arguments (a), members (m) and globals (g_) use prefixes for scope (though not in all structs), and CamelCase. Local variables are typically lower case, with underscores separating words. Statements and opening and closing braces for blocks should each be on their own line (i.e. not as below).

Code: Select all

[not as below]
} else
[as below]

Considerations / Comments By Lexikos

[is:pr commenter:Lexikos][pull requests with comments by lexikos]
Pull Requests · Lexikos/AutoHotkey_L · GitHub

[AHK v2 should support Windows Vista onwards, Unicode, 32-bit/64-bit]
[AHK v1.1 should support Windows 2000 onwards, ANSI/Unicode, 32-bit/64-bit]
[AHK v1.0 should support Windows 95 onwards, ANSI, 32-bit]

[to submit a pull request to AHK v1 and v2, submit it to AHK v1 only (the master branch), it will be merged with AHK v2 later]
[to submit a pull request to AHK v2 only, submit it to AHK v2 (the alpha branch)]
Added A_AhkMajorVersion by nnnik · Pull Request #115 · Lexikos/AutoHotkey_L · GitHub

[check compiler warnings]
Fix "Custom" control WM_NOTIFY handling by fincs · Pull Request #20 · Lexikos/AutoHotkey_L · GitHub

[have core.autocrlf turned on, for LFs, and not CRLFs]
Added a new ImageSearch method that has new features and speed improvements. by Rseding91 · Pull Request #18 · Lexikos/AutoHotkey_L · GitHub
Add an #InputLevel directive for controlling which generated inputs get ignored by russelldavis · Pull Request #7 · Lexikos/AutoHotkey_L · GitHub

[post issues (bug reports/suggestions) to the forum, not to GitHub]
why not bind coordmode to command? by hyaray · Pull Request #152 · Lexikos/AutoHotkey_L · GitHub


[C++ for AutoHotkey: summary info for the AutoHotkey source code, and code examples]
C/C++ - AutoHotkey Community
AutoHotkey C++ Powerhouse: Introduction - AutoHotkey Community

[Visual Studio version info]
compiling AutoHotkey: Visual Studio versions and components - AutoHotkey Community
AutoHotkey_L/ at master · Lexikos/AutoHotkey_L · GitHub
AutoHotkey_L/ at alpha · Lexikos/AutoHotkey_L · GitHub

[info for adding the accompanying documentation for new features]
GitHub: contributing to the AutoHotkey documentation - AutoHotkey Community

[further GitHub threads]
new forum proposal: GitHub subforum - AutoHotkey Community
homepage | tutorials | wish list | fun threads | donate
WARNING: copy your posts/messages before hitting Submit as you may lose them due to CAPTCHA

Return to “General Discussion”

Who is online

Users browsing this forum: BNOLI and 33 guests