Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved repository contributing guidelines to CONTRIBUTING.md and updated README.md #2386

Merged
merged 4 commits into from
Apr 27, 2024

Conversation

alinaghale88
Copy link
Contributor

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

  • PR contains only changes related; no stray files, etc.
  • README updated (where applicable)
  • Tests written (where applicable)
  • References provided in PR (where applicable)

Copy link

codecov bot commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4197b86) to head (95d081b).
Report is 16 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

Copy link
Member

@profnandaa profnandaa left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the suggestion.

@profnandaa profnandaa merged commit eacccaf into validatorjs:master Apr 27, 2024
9 checks passed
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