Skip to content

Conversation

@fifteen42
Copy link

Changes:

  • Convert README.txt to README.md format to follow GitHub's best practices
  • Improve documentation readability through Markdown formatting

Screenshots of the change:
Before:
image.png

After:
image.png

PR Checklist

  • npm run lint passes
  • Inline reference is included / updated (N/A - documentation format change only)
  • Unit tests are included / updated (N/A - documentation format change only)

@welcome
Copy link

welcome bot commented Feb 11, 2025

🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page!

@ksen0
Copy link
Member

ksen0 commented Mar 26, 2025

Hi @fifteen42 , I'll be closing this as this is a file in the lib distribution, so its intended audience is people who download the library and open it on their computer, so .txt is preferable to .md in that situation.

Also please check out the contributor guidelines for future reference:

You should not file a pull request (or start working on code changes) without a corresponding issue or before an issue has been approved for implementation; that is because the proposed fix may not be accepted, need a different approach entirely, or the actual problem is somewhere else. Any pull requests filed before the issue has been approved for fixing will be closed until approval is given to the issue.

@ksen0 ksen0 closed this Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants