Add Code Linting Rules
This commit is contained in:
parent
2b8f5309f1
commit
b90a210913
1 changed files with 14 additions and 1 deletions
15
README.md
15
README.md
|
@ -1,12 +1,25 @@
|
||||||
# 2DHackAndSlay
|
# 2DHackAndSlay
|
||||||
|
|
||||||
## Branches
|
## 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)
|
- [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
|
- [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-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
|
- 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:
|
## Resources used:
|
||||||
|
|
||||||
### Game Art
|
### Game Art
|
||||||
|
|
Reference in a new issue