RomanRom2/thunderbrew
1
0
Fork 0
mirror of https://github.com/thunderbrewhq/thunderbrew synced 2025-04-09 23:06:47 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore(docs): add contributing section to README

Browse Source
This commit is contained in:
fallenoak 2023-01-06 13:44:37 -06:00
parent 16ef6df00f
commit 7185fec1d9
No known key found for this signature in database
GPG Key ID: 7628F8E61AEA070D
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -26,6 +26,26 @@ Assuming all goes well, you should be greeted by the login screen, complete with
Whoa is very much a work-in-progress: it does not fully connect to a login server, does not play back sound or music, and does not support customizing settings. These things will be supported over time.
## Contributing
Thanks for making a contribution to Whoa!
Since Whoa is a faithful implementation of the original 3.3.5a (build 12340) client, there are some important considerations to keep in mind:
* Please use disassemblers and debuggers to determine original layouts and behaviors.
* Make every effort to maintain equivalent function signatures, function behaviors, class names, class layouts, structs, and enums as the original client. When an original name is not known, attempt to use names based on behavior. If behavior is not known, attempt to use names based on offsets.
* Occasionally, original layouts or behaviors must be changed to permit compilation on modern 64-bit systems. When behaviors differ for compatibility, the original behavior should be documented, and the variance explained.
General contribution guidelines:
* Follow formatting and style guidelines per the rules defined in `.clang-format` and `.editorconfig`. Ideally, configure your IDE to use both files.
* Keep pull requests tightly scoped to make reviews easier. Smaller pull requests, more of them.
* Keep commits formatted according to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
## FAQ
**Why?**