pytorch / pytorch/ignite

Add PR review guidelines

Open
#1,271 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
4.8k
Forks
726
Avg merge
5d 21h
Merged PRs (30d)
5

Description

🚀 Feature

Idea is to add a guidelines for PR reviewers. The document can be based on
https://github.com/numpy/numpy/blob/e4dfe6fd253c381cfa77dd995ac4614f6bc81dd3/doc/source/dev/reviewer-guidelines.rst

Thanks to @melissawm for creating it and pointing out it for me :) !

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the referenced NumPy reviewer-guidelines.rst document and locating the appropriate documentation or contributor-guidance entry point in the Ignite repository. Add a reviewer-guidelines document based on the requested idea, then verify that it is included where contributors can find it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.