Skip to content

Conversation

@pihanya
Copy link

@pihanya pihanya commented Aug 24, 2025

Summary

Hello, folks! 👋🏻

I noticed that README.md has not an actual path to rules directory. So I decided to submit a PR to you so documentation looks more consistent.

Therefore this PR fixes two small but important issues in README.md:

  1. Missing link to the rules directory – adds the correct relative path so contributors can quickly locate the rule files.
  2. Trailing newline – ensures the file ends with a newline, which is a POSIX best‑practice (see 🌍 StackOverflow | Why should text files end with a newline?) and prevents unnecessary diff noise.

Why

  • The README is the first point of contact for new contributors. Providing a direct link to the rules folder makes the documentation consistent with the repository layout and follows GitHub’s recommendation that a README “should only contain information necessary for developers to get started using and contributing to your project” (GitHub Docs).
  • A trailing newline is a widely‑adopted convention that improves readability in editors and diff tools. GitHub’s web editor automatically adds it, so keeping it in the file maintains a clean history.

Changes

File Change
README.md Fix path to rules folder to the apprortiate and ensured the file ends with a single newline.

Checklist

  • Documentation updated and verified by human.
  • No functional code changes are done; CI still should pass.
  • Followed repository’s contribution guidelines. I found none of them 😇

Additional notes

No new tests are required because this change only affects documentation formatting. Feel free to let me know if any further adjustments are needed.


Thank you for reviewing! 🙏

— pihanya

@vercel
Copy link

vercel bot commented Aug 24, 2025

@pihanya is attempting to deploy a commit to the Pontus Abrahamsson's projects Team on Vercel.

A member of the Team first needs to authorize it.

@pihanya
Copy link
Author

pihanya commented Aug 25, 2025

Hello @pontusab!

Very small changes to make Directories little better. Could you please give a review and merge?

Thank you!

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