Skip to content

Rename README.txt to README.md#1891

Closed
jackhenryellis wants to merge 1 commit intousnistgov:mainfrom
jackhenryellis:main
Closed

Rename README.txt to README.md#1891
jackhenryellis wants to merge 1 commit intousnistgov:mainfrom
jackhenryellis:main

Conversation

@jackhenryellis
Copy link
Copy Markdown

@jackhenryellis jackhenryellis commented Aug 17, 2023

Committer Notes

{Please provide a brief description of what this PR accomplishes. Be sure to reference any issues addressed. If the PR is a work-in-progress submitted for early review, please include [WIP] at the beginning of the title or mark the PR as DRAFT.}

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@aj-stein-nist aj-stein-nist self-requested a review August 23, 2023 17:13
Copy link
Copy Markdown
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First of @jackhenryellis, I want to thank you for your first PR to this project. Every one counts. Unfortunately, I do not think we can accept this one. This text file has this extension to signify to the project maintainers that the text file is ingested as-is as a preface to the auto-generated release notes generated by GitHub Actions when it processes a tagged released. It is not labeled as a Markdown file with that .md extension and accidentally signify it is developer-facing, public documentation for staff and those like yourself. So we will keep it as-is, but I do appreciate the recommendation. Do not feel discouraged from future contributions, big or small, but this file has the .txt extension as intended.

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.

2 participants