diff --git a/README.md b/README.md index 993756889a6..3f18890bdd1 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,9 @@ Lotus is a universally open project and welcomes contributions of all kinds: cod When implementing a change: 1. Adhere to the standard Go formatting guidelines, e.g. [Effective Go](https://golang.org/doc/effective_go.html). Run `go fmt`. -2. Stick to the idioms and patterns used in the codebase. Familiar-looking code has a higher chance of being accepted than eerie code. Pay attention to commonly used variable names, avoidance of naked returns, error handling patterns, etc. +2. Stick to the idioms and patterns used in the codebase. Familiar-looking code has a higher chance of being accepted than eerie code. Pay attention to commonly used variable and parameter names, avoidance of naked returns, error handling patterns, etc. 3. Comments: follow the advice on the [Commentary](https://golang.org/doc/effective_go.html#commentary) section of Effective Go. -4. Minimize code churn. Only modify what is strictly necessary to get a quicker response from maintainers. +4. Minimize code churn. Modify only what is strictly necessary. Well-encapsulated changesets will get a quicker response from maintainers. 5. Lint your code with [`golangci-lint`](https://golangci-lint.run) (CI will reject your PR if unlinted). 6. Add tests. 7. Title the PR in a meaningful way and describe the rationale and the thought process in the PR description.