Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-11 00:15:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update in-tree docs to point to the new book (#32743)

Browse source 
* Update in-tree docs to point to the new book

* Revive build setup section in README as quickstart guide

* Apply feedback about titles
This commit is contained in:
Delan Azabani 2024-07-09 23:42:00 +08:00 • committed by GitHub
parent 72e6a1f007
commit 34d9be70f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 63 additions and 1413 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/STYLE_GUIDE.md
View file

@ -1,29 +1,6 @@
# Style Guide
The majority of our style recommendations are automatically enforced via our
automated linters. This document has guidelines that are less easy to lint for.
Moved to the Servo book:
## Shell scripts
Shell scripts are suitable for small tasks or wrappers, but it's preferable to use Python for
anything with a hint of complexity or in general.
Shell scripts should be written using bash, starting with this shebang:
```
#!/usr/bin/env bash
```
Note that the version of bash available on macOS by default is quite old, so be
careful when using new features.
Scripts should enable a few options at the top for robustness:
```
set -o errexit
set -o nounset
set -o pipefail
```
Rememeber to quote all variables, using the full form: `"${SOME_VARIABLE}"`.
Use `"$(some-command)"` instead of backticks for command substitution. Note
that these should be quoted as well.
- Pre-book docs
- [docs/STYLE_GUIDE.md](https://book.servo.org/old/STYLE_GUIDE.html)