pyjanitor-devs/pyjanitor

[DOC] Update Pull Request Template with `netlify` option

Open

#750 opened on Sep 18, 2020

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Python (164 forks)batch import
available for hackingdocfixgood first issuehacktoberfest

Repository metrics

Stars
 (1,217 stars)
PR merge metrics
 (Avg merge 2d 12h) (4 merged PRs in 30d)

Description

Brief Description of Fix

Currently, the recommended approach for reviewing documentation updates is to build the docs locally. This may still be the recommended approach, but a note should be included that lets developers know that they can preview the docs from the PR checks as well (with the new netlify inclusion).

I would like to propose a change, such that now the docs have examples on how to use the netlify doc previews from a PR.

Relevant Context

Contributor guide

Research direction
Examine the current pull request template at .github/pull request template.md and add a note about using Netlify previews from PR checks. Also consider updating CONTRIBUTING.rst if needed.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90