Skip to content

Spelling Mistakes Issue Guidelines #2

@vcokltfre

Description

@vcokltfre

A large number of the issues on this repo are likely to be spelling mistakes I've made while writing it, so here's a guide to making issues about them so that I don't have to deal with 64 different formats to fix them, and they include all relevant information:

  1. Where possible group mistakes into one issue, not an issue for each error.
  2. Check that there isn't already an issue with the mistake you're pointing out. I'll try to keep up to date with the issues, so there likely won't be many to look through.
  3. Write the issues with the following guidelines:
  • The title should be spelling fix: <list of words>
  • The issue itself should contain the words, what each incorrect word should be, and a link to the file and line the error is on

Note that you're also more than welcome to create PRs to fix these issues yourself. If you do so be sure to comment on the issue that you have, and link the PR that fixes it.

Example issue:
Title: spelling fix: recomment, calrify

Words:

  • recomment -> recommend
  • calrify -> clarify

Both on https://github.com/vcokltfre/tutorial/blob/master/content/_index.md#L29

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions