yuan/suyu
1
0
Fork 0
mirror of https://git.suyu.dev/suyu/suyu.git synced 2025-08-08 05:36:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Contributing

zqpvr01 2024-03-22 12:37:19 +01:00
parent 26c21d2665
commit 0e672d6828
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Contributing.md

@ -1,12 +1,12 @@
# Reporting Issues
**The issue tracker is not a support forum.** Unless you can provide *precise technical information* regarding an issue, you *should not post in it*. If you need support, first read the [FAQ](https://github.com/yuzu-emu/yuzu/wiki/FAQ) and then either visit our [Discord server](https://discordapp.com/invite/u77vRWY), [our forum](https://community.citra-emu.org/c/yuzu-support) or ask in a general emulation forum such as [/r/emulation](https://www.reddit.com/r/emulation/). If you post support questions, generic messages to the developers or vague reports without technical details, they will be closed and locked.
**The issue tracker is not a support forum.** Unless you can provide *precise technical information* regarding an issue, you *should not post in it*. If you need support, first read the [FAQ](https://git.suyu.dev/suyu/suyu/wiki/FAQ) and then either visit our [Discord server](https://discordapp.com/invite/u77vRWY), [our forum](https://community.citra-emu.org/c/suyu-support) or ask in a general emulation forum such as [/r/emulation](https://www.reddit.com/r/emulation/). If you post support questions, generic messages to the developers or vague reports without technical details, they will be closed and locked.
If you believe you have a valid issue report, please post text or a screenshot from the log (the console window that opens alongside yuzu) and build version (hex string visible in the titlebar and zip filename), as well as your hardware and software information if applicable.
If you believe you have a valid issue report, please post text or a screenshot from the log (the console window that opens alongside suyu) and build version (hex string visible in the titlebar and zip filename), as well as your hardware and software information if applicable.
# Contributing
yuzu is a brand new project, so we have a great opportunity to keep things clean and well organized early on. As such, coding style is very important when making commits. We run clang-format on our CI to check the code. Please use it to format your code when contributing. However, it doesn't cover all the rules below. Some of them aren't very strict rules since we want to be flexible and we understand that under certain circumstances some of them can be counterproductive. Just try to follow as many of them as possible.
suyu is a brand new project, so we have a great opportunity to keep things clean and well organized early on. As such, coding style is very important when making commits. We run clang-format on our CI to check the code. Please use it to format your code when contributing. However, it doesn't cover all the rules below. Some of them aren't very strict rules since we want to be flexible and we understand that under certain circumstances some of them can be counterproductive. Just try to follow as many of them as possible.
## Using clang-format
@ -68,7 +68,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
// then, library includes
#include <nihstro/shared_binary.h>
// finally, yuzu includes
// finally, suyu includes
#include "common/math_util.h"
#include "common/vector_math.h"