|
| 1 | +## Pull Requests |
| 2 | + |
| 3 | +Please keep pull requests **relatively small and focused**. Smaller, self-contained PRs |
| 4 | +are much easier for me to test, validate, and review — which means they get merged faster. |
| 5 | +If you have a large change in mind, consider splitting it into several logical PRs. |
| 6 | + |
| 7 | +## Tests |
| 8 | + |
| 9 | +The `master` branch is kept free of tests to stay lightweight, all tests live on the |
| 10 | +[tests branch](https://github.com/Azzinoth/VisualNodeSystem/tree/tests). |
| 11 | + |
| 12 | +Before submitting, your new code should **pass the existing tests**. |
| 13 | + |
| 14 | +If a test fails but you believe the **test itself is flawed** (it happens), do not silently |
| 15 | +work around it. Instead, call it out in your pull request: |
| 16 | + |
| 17 | +- which test is failing. |
| 18 | +- why you think the test is wrong. |
| 19 | +- what you think it should check instead. |
| 20 | + |
| 21 | +## Use of AI |
| 22 | + |
| 23 | +There is **no "no-go" policy on AI**, you are welcome to use it. |
| 24 | + |
| 25 | +The one thing I ask: use AI as a targeted tool not in "vibe coding" style, and **review its output before you submit.** AI tools often introduce |
| 26 | +unneeded or unrelated changes that balloon a PR and make it hard to review. Trim those down |
| 27 | +so the diff contains only what the change actually needs, and you do not end up with a giant, |
| 28 | +hard-to-review pull request. |
| 29 | + |
| 30 | +## Code Style |
| 31 | + |
| 32 | +The conventions are **somewhat close to Unreal Engine's**: |
| 33 | + |
| 34 | +- **PascalCase** for types, functions, and variables (including locals and parameters). |
| 35 | +- **Braces: Allman** the opening brace goes on its own line. |
| 36 | +- **Booleans: `b` prefix everywhere** e.g. `bHovered`, `bNewValue`, `bIsValid`. |
| 37 | +- **Macros, compile-time constants, and enums: `ALL_CAPS_WITH_UNDERSCORES`**. |
| 38 | +- **Single-statement `if`/`for` bodies omit braces** put the statement on the next indented line. |
| 39 | +- **Tabs** for indentation. |
| 40 | + |
| 41 | +## C++ Standard |
| 42 | + |
| 43 | +The project currently targets **C++17**. You may use any language or standard-library feature up to and including C++17. |
0 commit comments