From b90a210913df69aae3e1cd893303d3a4ce0af1e7 Mon Sep 17 00:00:00 2001 From: snoweuph Date: Fri, 3 Feb 2023 13:54:04 +0100 Subject: [PATCH] Add Code Linting Rules --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 734d066..0ab5cbe 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ # 2DHackAndSlay ## Branches - - [stable](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/stable) - This is the Most stable branch and only will get PRs from [nightly](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/nightly) - [nightly](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/nightly) - This Branch will only get PRs from [dev-base](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/dev-base)its meant for testing - [dev-base](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/dev-base) - On This branch the Diffrent dev branches will be merged and code may be written to combine everything. when this branch is at a somewhat stable branch it gets a PR to [nightly](https://git.euph.dev/GameDev/2DHackAndSlay/src/branch/nightly) - dev-* - Dev branches with their respective goal which will be merged into dev-base +## Code Linting Rules +### Use Tabs +Tabs are just cooler + +### Use Sign-Form instead of Text-Form + +#### Why +There are a lot of Operators in godot, and most are based around signs, so for consistency we stay at the Sign-Forms + +#### Boolean operators +- `&&` instead of `and` +- `||` instead of `or` +- `!` instead of `not` + ## Resources used: ### Game Art