From 6399a0bed8474f2bbaf6da8648c38b4ddb6409e2 Mon Sep 17 00:00:00 2001 From: Chris Hager Date: Fri, 3 Nov 2023 13:45:42 +0100 Subject: [PATCH] contributing cleanup --- CONTRIBUTING.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 594097df8..5e24824bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,17 @@ -# Contributing guide +# Contributing to suave-geth Welcome to the Flashbots collective! -Thanks for your help improving the project! We are so happy to have you! We just ask you to be nice when you play with us. +Thanks for your help improving the project, we are so happy to have you! -Please start by reading our [license agreement](#individual-contributor-license-agreement) below, and our [code of conduct](suave/CODE_OF_CONDUCT.md). +Please read our [license agreement](#individual-contributor-license-agreement) below, and our [code of conduct](/CODE_OF_CONDUCT.md). -## Code style - -Start by making sure that your code is readable, consistent, and pretty. -Follow the [Clean Code](https://flashbots.notion.site/Clean-Code-13016c5c7ca649fba31ae19d797d7304) recommendations. ## Send a pull request - Your proposed changes should be first described and discussed in an issue. -- Open the branch in a personal fork, not in the team repository. - Every pull request should be small and represent a single change. If the problem is complicated, split it in multiple issues and pull requests. -- Every pull request should be covered by unit tests. +- Every pull request should be covered by tests. We appreciate you, friend <3.