docs: fix path to rules folder in README.md #280
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.
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:
rulesdirectory – adds the correct relative path so contributors can quickly locate the rule files.Why
rulesfolder 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).Changes
README.mdChecklist
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