From afe587c91b22b74f6534103a4e5b7e1c8f977444 Mon Sep 17 00:00:00 2001 From: drjaska Date: Sat, 15 Feb 2025 14:14:16 +0200 Subject: [PATCH] Add XONRELEASE TODO in style guide Closes https://gitlab.com/xonotic/xonotic-data.pk3dir/-/issues/2943 --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2aa5615..2b33ac6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -133,6 +133,18 @@ This should be approximately consistent with the [DarkPlaces style](https://gitl Functions in CamelCase, macros in UPPERCASE. Underscores should be included if they improve readability. +- TODO notes which are time sensitive and pending on a release period to begin or end in + order to be actionable should use the following formatting. + The version number is a git release tag such as `xonotic-v0.8.2`, + existing tags can be found [here](https://gitlab.com/xonotic/xonotic/-/tags). + + ```c + // XONRELEASE TODO: xonotic-v0.9 before release drink water + // XONRELEASE TODO: xonotic-v0.8.6 before release candidate eat food + // XONRELEASE TODO: xonotic-v0.8.5 after release hydrate more + // XONRELEASE TODO: xonotic-v0.8.2 after release candidate take a shower + ``` + - If following these guidelines in any manner would make any code less readable or harder to follow, ***ignore them***. This section is only guidelines, not rules. We're not going to beat you over the head in -- 2.39.5