Skip to content

2. Pull requests for core DVC changes

Jump to bottom
Jorge Orpinel edited this page Jun 16, 2022 · 1 revision

This document is meant mainly for the core DVC team (https://github.com/iterative/dvc devs).

Sending a (draft) PR to this repo to reflect changes in the core repo (iterative/dvc) is very helpful for the docs team:

  1. It saves the time in understanding the change in question;
  2. It provides a suggestion of which documents and sections to update;
  3. It (ideally) conveys the main idea that should be reflected in docs.

Often only minor "copy edits" are needed to merge the PR. But even if the entire text is rewritten, the idea provided by the core team, which is the main contribution, will be preserved (and possibly expanded on).

Any rounds of feedback (hopefully not too many) will focus on the concept and explanation, not language.

Technical note: Please open a pull request from a branch directly on this repo if you can (as opposed to using a fork). This makes it easy for the docs team to "take over" the PR if needed: easier checkout, ability to commit to it, etc. It also automatically deploys a review web app for visual sanity checks.

Clone this wiki locally