Skip to content

Commit 8da50c9

Browse files
author
Joan Fontanals
authored
docs: add code review to contributing.md (#1853)
1 parent 5037635 commit 8da50c9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ In this guide, we're going to go through the steps for each kind of contribution
1414
- [➕ Adding a dependency](#adding-a-dependency)
1515
- [💥 Testing DocArray Locally and on CI](#-testing-docarray-locally-and-on-ci)
1616
- [📖 Contributing Documentation](#-contributing-documentation)
17+
- [Code Review](#-code-review)
1718
- [🙏 Thank You](#-thank-you)
1819

1920
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -321,6 +322,16 @@ Good docs make developers happy, and we love happy developers! We've got a few d
321322
* Tutorials/examples
322323
* Docstrings in Python functions in RST format - generated by Sphinx
323324

325+
## ✅ Code Review
326+
327+
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.
328+
329+
* Try to check that the guidelines specified in this document are followed.
330+
331+
* Try to check the presence of new tests covering the new or changed feature added by the code review.
332+
333+
* Check that documentation changes follow the standards of quality and describe the features clearly.
334+
324335
### Documentation guidelines
325336

326337
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.

0 commit comments

Comments
 (0)