getodk / getodk/docs

Line Edits

Open
#96 7 comments 1 reaction 0 assignees View on GitHub
bad markup/formatting easy grammar/style problems help wanted
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

This is a perpetual issue, never closed.

Typos sneak in, and branch-based editing makes it inconvenient to go chasing them every time you notice them. So...

If you are:

- between issues
- a little too sleepy in the afternoon to think about high-level stuff
- a new comer looking for something to do

Start a line-edit branch, fix some typos, and submit a small PR.

## Guidelines for line-edit PRs

- Typos and basic fixes only; don't rewrite or move sections (You *can* rewrite or move sections, but that needs to be done in individual Issue-Discussion-PR cycles.)
- Spelling
- Punctuation
- Basic grammar
- Markup corrections
- Fix links (external and cross references)
- If you aren't sure, err on the side of not changing something
- If something needs long task-oriented discussion, file an issue
- If you need quick clarity on some point of confusion, use the docs-code channel on the [ODK Slack](https://opendatakit.slack.com)
- Run the build to make sure you didn't introduce errors
- Don't use line edits to pursue personal grammar pet peeves
- PR a single document at a time
- line-edit PRs don't need a long description; the edits should speak for themselves
- reference this issue number in your PR message, but don't say that it "closes" the issue

Contributor guide

Open the contributing guide

Research direction

Choose one documentation file and make only typo, punctuation, basic grammar, markup, or link corrections. Run the Sphinx build to check for errors; done means the single-document edits are submitted as a small PR without closing this issue.

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
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.