Skip to content

docs: add code review to contributing.md #1853

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoanFM merged 1 commit into from
Feb 8, 2024
Merged

docs: add code review to contributing.md #1853

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -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.
Expand Down