contributing

doiksub is open source. drop plugins, fixes, docs, whatever u want.

ai policy

⚠️

keep it mostly human. using ai for tiny snippets is fine, ai is useful when it's properly used (and as a tool), but fully vibecoded prs will get trashed. dont use ai for ur pr description or readme either, why put in the work then not even write a proper description.

pull requests

honestly this is barely functional as it is, so pull requests are not thought of currently. i will have a seperate branch no doubt, but for now it's just me. that being said, i won't just instantly close prs, i'll still keep them for others or for me to eventually get to.

writing plugins

plugins are the main thing here. scaffold one with:

pnpm new-plugin myPluginName

this drops a new folder at src/plugins/myPluginName/ with a starter index.ts. check existing plugins in there for reference.

vencord's dev docs cover the api pretty well. though, doiksub has modified api's at some places, so it's always good to double check the actual source too. once it's in a stable state, i'll properly document how to actually code your own shit.

before starting a plugin

make sure its actually useful to a lot of people, niche stuff usually doesnt get merged
check open prs so u dont step on toes
read the rules below

plugin rules

these types of plugins are not accepted:

simple text replacers, built in TextReplace already does this
raw dom manipulation, use proper patches and react
plugins that mess with specific discord bots (just cause we're fuckin up discord doesnt mean to be dicks to other communities)
sketchy third party apis, google or github are fine but random self hosted stuff isnt

other ways to help

bug fixes and typos - open a pr, dm, or email the owner
docs - if something here is wrong just fix it
discord support - help people out in the support channels (will be getting a server soon)

all contributions gotta follow the code of conduct.