Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #8

Merged
merged 1 commit into from
Nov 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down