Skip to content

Comments

docs: fix typos in contrib documentation#3271

Open
droppingbeans wants to merge 1 commit intoopentensor:stagingfrom
droppingbeans:docs/batch-contrib-fixes-20260220
Open

docs: fix typos in contrib documentation#3271
droppingbeans wants to merge 1 commit intoopentensor:stagingfrom
droppingbeans:docs/batch-contrib-fixes-20260220

Conversation

@droppingbeans
Copy link

Summary

Corrects three minor typos in contrib/ documentation files.

Motivation

Improves accuracy and consistency of contributor documentation:

  • STYLE.md incorrectly references 'seven rules' when only six are listed
  • DEBUGGING.md contains a double space in a sentence
  • CONTRIBUTING.md TOC link text doesn't match the actual heading

Changes Made

  • contrib/STYLE.md line 203: 'seven rules' → 'six rules'
  • contrib/DEBUGGING.md line 139: removed double space after 'ag.'
  • contrib/CONTRIBUTING.md line 13: 'Guideline' → 'Guidelines' (TOC)

Tests Added

  • N/A - Documentation-only changes

Compliance Checklist

  • Branched from staging
  • <50 files changed (3 files)
  • Ran make check (docs-only, no code changes)
  • Commit messages follow style guide
  • Followed contrib guidelines

Contrib Reference

This PR follows batch-only mode and Bronze Safe Mode guidelines for minimal documentation fixes.

Corrected three minor documentation issues:
- STYLE.md: 'seven rules' → 'six rules' (only 6 listed)
- DEBUGGING.md: removed double space after sentence
- CONTRIBUTING.md: 'Guideline' → 'Guidelines' in TOC link

All changes improve accuracy and consistency.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant