From 5c066a73192cd2a843c8529f88718bf564b91d85 Mon Sep 17 00:00:00 2001 From: PortSwiggerWiener <136816696+PortSwiggerWiener@users.noreply.github.com> Date: Mon, 27 Nov 2023 11:17:32 +0000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6db3afc..427b7cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,9 +16,11 @@ Please note that we have a code of conduct. Please follow it in all your interac 1. Please make sure the Bambda is syntactically valid. 2. Please make sure the Bambda is formatted correctly. + - Ensure that there is a JavaDoc style comment describing the Bambda containing an appropriate @author tag. For an example see [this bambda](https://github.com/PortSwigger/bambdas/blob/main/Proxy/HTTP/FilterOnCookieValue.bambda) - Indentation is four spaces, not tabs. -3. Please make sure the Bambda is optimized. -4. Please avoid excessive use of comments. + - Ensure that the filename uses camel casing. +4. Please make sure the Bambda is optimized. +5. Please avoid excessive use of comments. - Use of appropriately named variables should mean that your Bambda is self-documenting.