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.