Fix minor typos and file name in contributing docs #1651
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
A1-insubstantial
bkchr
approved these changes
Sep 20, 2023
ggwpez
approved these changes
Sep 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context,
including:
This PR fixes two minor typos in the contributing top level docs, and fixes a broken link to another file.
While reading the guidelines I noticed two small typos and a broken link to the documentation guidelines in the same directory.
Both typos were fixed. The file has been renamed from
DOCUMENTATION_GUIDELINE.mdtoDOCUMENTATION_GUIDELINES.mdto 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