Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 970 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 970 Bytes

Contributing

Project structure

ShowHiddenChannels.plugin.js (root) is not the real plugin, it is only an auto-updater stub that BetterDiscord loads to keep the plugin up to date. Do not edit it directly.

The actual plugin source lives in src/. After making changes, run the build to produce the distributable:

bun run build

Bumping the version

  1. Edit src/config.json:
    • Increment "version".
    • Add a new entry at the top of the "changelog" array.
    • Remove the oldest (last) entry so the array always contains exactly 3 entries.

Example structure:

"changelog": [
  { "title": "v1.2.0 - New stuff", "type": "added",   "items": ["Added X."] },
  { "title": "v1.1.0 - Fixes",     "type": "fixed",   "items": ["Fixed Y."] },
  { "title": "v1.0.0 - Release",   "type": "added",   "items": ["Initial release."] }
]

Valid values for type: "fixed", "added", "progress", "changed".