Skip to content

Commit

Permalink
contributing cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris committed Nov 3, 2023
1 parent b328d64 commit 6399a0b
Showing 1 changed file with 4 additions and 9 deletions.
13 changes: 4 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 6399a0b

Please sign in to comment.