-
Notifications
You must be signed in to change notification settings - Fork 153
Guidelines
Christian Fillion edited this page Jan 29, 2025
·
20 revisions
- Duplicate from a ReaTeam repository, REAPER or SWS
- Edits to someone else's packages without publicly-accessible authorization
- Obfuscation with the intent of hiding the source code, pre-compiled Lua
- Pull Requests not sent by the original author of the code
- Spam/AI-generated garbage/obviously nonfunctional/unoriginal code
-
@description
too far from the action filenames (hard to search) - Exceedingly large version number in risk of eventually reaching the 16-bit limit
- Externally-sourced files (except extensions and themes)
- For extension and themes: external URL is not pinned to the specific version or does not forever permit download of historic versions for downgrading
- Index modified (should let reapack-index do it automatically)
- os.execute/io.popen usage vulnerable to command injection
- Letters in the version name without intent of making a pre-release
- Multiple related actions submitted as separate packages rather than one
- New version number lower than the previous (eg. 1.19 -> 1.2, maybe the intent was 1.20)
- File installed on an unsupported platform (should be fixed to be cross-platform if possible, otherwise the file must only be installed on supported platforms via
@provides
) - ReaImGui with backward-compatibility disabled or bypassed
- Unnecessarily heavy or installs huge amount of files
- Main file renamed (= new package), action/JSFX file renamed (= shortcut loss/broken projects...)
- Weirdly large version skip (eg. 2.1 -> 2.11, maybe the intent was 2.1.1)
(if few and 100% obvious – otherwise request changes or ask confirmation)
- Any reapack-index validation errors
- Bad/missing author prefix or file extensions (author prefix should match other submissions by the same user)
- Characters in filenames illegal on Windows
- Duplicate metadata header or misc metadata oddities
- Incorrect Action List section(s)
- Incorrect file type (eg. JSFX in a script package not marked as an effect in
@provides
) - Library files registered in the Action List (or vice-versa)
- Miscategorized (wrong folder)
- More than one version's worth of release notes in the changelog
- Scripts names not using sentence case
- Typos in filenames
- Version number in the changelog
- Incorrect paths to other package files in code
Can optionally comment on the code as a courtesy (not as a requirement for merging/, not a code review).