From 3a7b739e5ab6fe122af53d56daacf2bc3d546f70 Mon Sep 17 00:00:00 2001 From: gravel Date: Mon, 26 Aug 2024 08:56:43 +0000 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46b73c7..67f34ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)