From f1f9d87e5f0a4d064a2bfc0db0a24071656cc1de Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Sat, 14 Mar 2020 20:39:25 +0100 Subject: [PATCH] reviews --- Cross-road.md | 1 - Review-guidelines.md | 10 ++++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) delete mode 100644 Cross-road.md create mode 100644 Review-guidelines.md diff --git a/Cross-road.md b/Cross-road.md deleted file mode 100644 index 57d0f1e..0000000 --- a/Cross-road.md +++ /dev/null @@ -1 +0,0 @@ -Welcome to the pytorch-lightning wiki! diff --git a/Review-guidelines.md b/Review-guidelines.md new file mode 100644 index 0000000..cc3e5f0 --- /dev/null +++ b/Review-guidelines.md @@ -0,0 +1,10 @@ +Some recommended steps for reviewing open PRs. + +1. Check the **source issues if the fix solves it** +2. Read the changes if they are aligned with our code-base +3. Check if the changes (fixed issue) are **covered by tests** +4. Check if the change is mentioned in **CHANGELOG** (no need for typos, docs and CI) + +Hints: +- **be nice and constructive**, remember you fist PR and what helped you / made motivated to continue with contributing +- use suggestions for simple edits when you know what it shall be intead of long description (you can still add short justification of your proposal) so the author can simply accept it...