docs: update CONTRIBUTING.md

dev
gravel 9 months ago
parent 16f625199a
commit 3a7b739e5a
No known key found for this signature in database
GPG Key ID: CA95FFF4E0123903

@ -21,13 +21,13 @@
### Structure
[`fetch-servers.php`](php/fetch-servers.php) queries available servers, and [`generate-html.php`](php/generate-html.php>) generates static HTML. Static HTML is generated from the [`sites`](sites) directory to the [`output`](output) directory, which additionally contains static assets. All contents of `sites` are invoked to produce a HTML page unless they are prefixed with a `+` sign.
[`fetch-servers.php`](php/fetch-servers.php) queries available servers, and [`generate-html.php`](php/generate-html.php) generates static HTML. Static HTML is generated from the [`sites`](sites) directory to the [`output`](output) directory, which additionally contains static assets. All contents of `sites` are invoked to produce a HTML page unless they are prefixed with a `+` sign.
### Development
Run at least once: `make fetch` to query servers. This takes around 15 seconds thanks to the coroutine implementation.
Run at least once: `make fetch` to query servers. This takes around 30 seconds thanks to the coroutine implementation. Alternatively, run `make fetch-steal` to copy the fetching results from SessionCommunities.online.
Run when developing: `make dev` to watch for changes & serve HTML locally in browser.
Run when developing: `make dev` to watch for changes & serve HTML locally in browser, or `make lan-dev` to also expose the website to LAN and view the site on a mobile device.
See [`Makefile`](Makefile) for more details.
@ -62,7 +62,7 @@ This ensures that references to components are not broken when the page changes
### PHP
**Identifier casing**: `snake_case` and `CONSTANT_CASE`
**Identifier casing**: `snake_case` or `camelCase`, `PascalCase` for classes, and `CONSTANT_CASE` for constant members
**Comments and documentation**: [Doxygen](https://en.wikipedia.org/wiki/Doxygen)

Loading…
Cancel
Save