From d57fdea4ff3aeb2ae8b116b3c9f27c4f8466c674 Mon Sep 17 00:00:00 2001 From: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> Date: Fri, 5 Jul 2024 10:55:19 +0200 Subject: [PATCH 1/2] docs: update contribution guidelines --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c27b1b..9df2c5b 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,13 @@ Relevant Waku resources related to the specifications located in this repository Contributions are welcome from any party. Contributors can create specifications relating to the Waku domain and create a pull request to begin discussion. -The recommended [template](./template.md) may be used for new proposed specifications. + +Please adhere to the following contribution guidelines: +- use the recommended [template](./template.md) for new proposed specifications +- use keywords as per the language recommendations in the [template](./template.md) and [Vac COSS](https://github.com/vacp2p/rfc-index/blob/a5b24ac0a27da361312260f9da372a0e6e812212/vac/1/coss.md#language) +- use [semantic breaks](https://sembr.org/) +- links to other Waku, Vac or 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/). New specifications are considered a proof of concept. Once a rough consensus is reached towards stabilization, From 0998089fbe354aa8955bf423aff68b6f738cc985 Mon Sep 17 00:00:00 2001 From: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> Date: Mon, 8 Jul 2024 09:16:33 +0100 Subject: [PATCH 2/2] docs: clarify org-related specs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9df2c5b..256ff41 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ Please adhere to the following contribution guidelines: - use the recommended [template](./template.md) for new proposed specifications - use keywords as per the language recommendations in the [template](./template.md) and [Vac COSS](https://github.com/vacp2p/rfc-index/blob/a5b24ac0a27da361312260f9da372a0e6e812212/vac/1/coss.md#language) - use [semantic breaks](https://sembr.org/) -- links to other Waku, Vac or related specifications must be to the corresponding Github repository and not to a webpage. +- 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/). New specifications are considered a proof of concept.