stan-dev / stan-dev/docs

Instructions for working with PRs from forks

Open
#936 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TeX
Stars
43
Forks
133
Avg merge
11h 32m
Merged PRs (30d)
4

Description

We are getting more pull requests from people outside of Stan-dev and there are no instructions on how to build the docs using a pull request from a fork. I'm sure it's just the usual, but I find it incredibly hard to figure this stuff out when all I want to do is review a pull request.

While someone's at it, they can fix the capitalization of "It" and not use code style for section headers. As is, the "It" looks like it's starting a new sentence, whereas it's really continuing a previous one and then the code style looks like what's being called. Just use descriptive headers.

Contributor guide

No contributing guide indexed for this repository

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

No file or test is named. Locate the documentation section covering pull requests from forks, then document how to build the docs for review and revise the capitalization and section headers described in the issue; done means the fork workflow is understandable and the wording is corrected.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
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.