From 75efe89b46d9ce05fe9fd07aa673ac7daf4424a1 Mon Sep 17 00:00:00 2001 From: Joan Martinez Date: Thu, 8 Feb 2024 18:47:18 +0100 Subject: [PATCH] docs: add code review to contributing.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1655402bcc..4c153ae2c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,7 @@ In this guide, we're going to go through the steps for each kind of contribution - [➕ Adding a dependency](#adding-a-dependency) - [💥 Testing DocArray Locally and on CI](#-testing-docarray-locally-and-on-ci) - [📖 Contributing Documentation](#-contributing-documentation) +- [Code Review](#-code-review) - [🙏 Thank You](#-thank-you) @@ -321,6 +322,16 @@ Good docs make developers happy, and we love happy developers! We've got a few d * Tutorials/examples * Docstrings in Python functions in RST format - generated by Sphinx +## ✅ Code Review + +Reviewing Pull Requests is also a great way to contribute to the project. When doing code review, please be mindful about the author and the effort they are putting into the contribution. Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning. + +* Try to check that the guidelines specified in this document are followed. + +* Try to check the presence of new tests covering the new or changed feature added by the code review. + +* Check that documentation changes follow the standards of quality and describe the features clearly. + ### Documentation guidelines 1. Decide if your page is a **user guide or a how-to**, like in the `Data Types` section. Make sure it fits its section. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy