From 0a4aa8add5ebbd2e8cdd894d1996512c813989dd Mon Sep 17 00:00:00 2001 From: Joe Date: Fri, 29 Jul 2022 11:24:42 +0100 Subject: [PATCH] refine code review and contribution guidelines --- content/docs/developers/contributing.md | 2 +- .../{Code-Review-Guidelines.md => code-review-guidelines.md} | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) rename content/docs/developers/geth-developer/{Code-Review-Guidelines.md => code-review-guidelines.md} (97%) diff --git a/content/docs/developers/contributing.md b/content/docs/developers/contributing.md index d07ecd0726..44d4a9a33f 100644 --- a/content/docs/developers/contributing.md +++ b/content/docs/developers/contributing.md @@ -27,7 +27,7 @@ unless by explicit agreement because the work is contributing to some more compl feature branch. All pull requests will be reviewed according to the -[Code Review guidelines](/content/docs/developers/geth-developer/Code-Review-Guidelines.md). +[Code Review guidelines](/content/docs/developers/geth-developer/code-review-guidelines.md). We encourage an early pull request approach, meaning pull requests are created as early as possible even without the completed fix/feature. This will let core devs and other diff --git a/content/docs/developers/geth-developer/Code-Review-Guidelines.md b/content/docs/developers/geth-developer/code-review-guidelines.md similarity index 97% rename from content/docs/developers/geth-developer/Code-Review-Guidelines.md rename to content/docs/developers/geth-developer/code-review-guidelines.md index cfe6ae85d3..e19da73f90 100644 --- a/content/docs/developers/geth-developer/Code-Review-Guidelines.md +++ b/content/docs/developers/geth-developer/code-review-guidelines.md @@ -3,7 +3,7 @@ title: Code Review Guidelines sort_key: B --- -The only way to get code into go-ethereum is to send a pull request. Those pull requests +The only way to get code into Geth is to submit a pull request (PR). Those pull requests need to be reviewed by someone. This document is a guide that explains our expectations around PRs for both authors and reviewers. @@ -11,9 +11,12 @@ around PRs for both authors and reviewers. * The **author** of a pull request is the entity who wrote the diff and submitted it to GitHub. + * The **team** consists of people with commit rights on the go-ethereum repository. + * The **reviewer** is the person assigned to review the diff. The reviewer must be a team member. + * The **code owner** is the person responsible for the subsystem being modified by the PR. ## The Process