Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.54 KB

Qtcord Contributor Agreement and Guidelines

By contributing to this repository, you agree that I (mak448a) have the rights to use the code contributed to this repository however I want, under any license. If you disagree with this, you can ask for me to make this a little less ridiculous. DISCLAIMER: I am just doing this in case if I have to copy and paste from this repository or relicense the code.

Discord API Usage

I highly recommend this tutorial for getting started with reverse engineering the Discord API. More notes are in projects_notes.txt. For API testing on Linux, I recommend this app. If you're on Windows, just stick with Python requests. You can use following resources for API docs.

Coding Guidelines

Try to follow PEP-8 (the squiggly underlines in Pycharm) standards. If you can't, that's perfectly fine. You can use a code formatter called Ruff if needed.

If you add a dependency, make sure to add the appropriate license to the licenses folder.

To edit the user interface, use QT designer and put the UI files under src/ui. To apply the UI, run src/regenerate.py.

Packaging

If you want to package for Linux, take a look at https://github.com/flathub/io.github.mak448a.QTCord. If you want to package for Windows, run package_windows.py. If you want to package for macOS, run package_macos.py.