Moved repository contributing guidelines to CONTRIBUTING.md and updated README.md #2386
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2386 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 107 107
Lines 2449 2449
Branches 619 619
=========================================
Hits 2449 2449 ☔ View full report in Codecov by Sentry. |
profnandaa
approved these changes
Apr 27, 2024
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.
The README.md file of the validator.js repository, at present, is loaded with huge chunks of information, most notably the extensive list of validators. The presence of the validators list is crucial in the README.md file but the importance of the other information cannot be overlooked as well.
The contribution guidelines can exist as a separate entity holding a good quantity of information. So, to make it more accessible, I have created a dedicated CONTRIBUTING.md file where I have shifted all the necessary information. Also, I have formatted the content slightly and added relevant links to better the user experience.
Checklist