Skip to content

Fix minor typos and file name in contributing docs#1651

Merged
ggwpez merged 4 commits into
masterfrom
donal-fix-contributing-docs
Sep 20, 2023
Merged

Fix minor typos and file name in contributing docs#1651
ggwpez merged 4 commits into
masterfrom
donal-fix-contributing-docs

Conversation

@seadanda

Copy link
Copy Markdown
Contributor

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context,
including:

  • What does this PR do?

This PR fixes two minor typos in the contributing top level docs, and fixes a broken link to another file.

  • Why are these changes needed?

While reading the guidelines I noticed two small typos and a broken link to the documentation guidelines in the same directory.

  • How were these changes implemented and what do they affect?

Both typos were fixed. The file has been renamed from DOCUMENTATION_GUIDELINE.md to DOCUMENTATION_GUIDELINES.md to match the link, as the link seems correct vs the filename. There are no other references to this file within this repo.

There are no open issues related to this

DOCUMENTATION_GUIDELINES.md is referred to in CONTRIBUTING.md, but the
file is wrongly named. No other refs to the old name exist in the repo.
@seadanda seadanda added A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). T11-documentation This PR/Issue is related to documentation. labels Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A1-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). T11-documentation This PR/Issue is related to documentation.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants