Giters

getodk / docs

The documentation for all the ODK tools. This is one of the most popular artifacts our community produces. It's built in Sphinx. ✨📚✨

Home Page:https://docs.getodk.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Line Edits

adammichaelwood opened this issue · comments

commented

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
  • 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
commented

@adammichaelwood Shall I work on this?

commented

Everyone can work on line edits at any time.
(Don't use the "Closes" syntax in your commit messages.)

commented

Hi,
How can I start with this?
Thanks

commented

@nadaa

Read the contributor's guide. That provides instruction for setting up your local environment and getting started. Then just pick a file that has spelling or punctuation errors and fix them.

If you need help getting your tooling and authoring environment set up, talk to us on the developer slack, in the #docs-code channel.

commented

Thank you @adammichaelwood.
I am following the contribution guide. I use windows (Cygwin) to setup the authoring tools, and I noticed there are no enough instructions in the guide. I will prepare a short doc to describe my approach.

Regards

commented

I use windows (Cygwin) to setup the authoring tools, and I noticed there are no enough instructions in the guide.

Yes. We need more details on the Windows experience. Most of us are Mac or Linux people, but we would like to encourage Windows users to contribute.

I will prepare a short doc to describe my approach.

Great. That would be very helpful.

IF you can incorporate that into the contributors guide, great. IF it makes more sense as a standalone doc, that would be fine too.

There's an issue for this: #95
We'd love for you to work on that.

commented

Quick note:

Please do not submit line edits for the Cygwin guide at this time, unless you are directly working on #159