From ca2e5534d38c8a05ac663eed16e5a6e4ca444556 Mon Sep 17 00:00:00 2001 From: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> Date: Tue, 6 Aug 2024 12:04:22 +0100 Subject: [PATCH] chore: add contribution guidelines for spec names and titles --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d13f926..61cc4a9 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,8 @@ Please adhere to the following contribution guidelines: - use [semantic breaks](https://sembr.org/) - links to Waku, Vac or other [IFT](https://free.technology/)-related specifications must be to the corresponding Github repository and not to a webpage. For example, Waku specs reside in [waku-org/specs](https://github.com/waku-org/specs) and Vac RFCs in [vacp2p/rfc-index](https://github.com/vacp2p/rfc-index/). +- we no longer use "v2" in the _name_ of new specifications (and existing spec names inconsistent with this rule will eventually be revised). For example, do not call your specification "Waku v2 New Protocol" but simply "Waku New Protocol" +- the _title_ of new specifications must be prefixed with `WAKU2-` to differentiate it from other projects' specs and previous RFC generations. For example, "Waku New Protocol" could be titled `WAKU2-NEW-PROTOCOL`. New specifications are considered a proof of concept. Once a rough consensus is reached towards stabilization,