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

fix(docs): improve the contribution guidelines #2552

Merged
merged 6 commits into from
Apr 8, 2024

Conversation

wellwelwel
Copy link
Collaborator

@wellwelwel wellwelwel commented Apr 2, 2024

This PR improves the Contributing Guidelines based in some recent events.


c8

  1. Force all files to be checked in the coverage test using the all option.
  • Files that were ignored (0%):
    • lib/packets/binlog_query_statusvars.js
    • lib/results_stream.js
  1. Include a manual coverage check:
  • When submitting a PR with the base before Codecov was implemented, it will not verify coverage.

Contributing Guidelines

  1. Add two new sections to Development:

Commits and Pull Request Titles

To ensure a clean commit history pattern, please use the Conventional Commits format.

Prefixes that will trigger a new release version:

  • fix: for patches, e.g., bug fixes that result in a patch version release.
  • feat: for new features, e.g., additions that result in a minor version release.

Examples:

  • fix: message
  • feat: message
  • docs: message
  • fix(module): message
  • feat(module): message
  • etc.

Including Tests

Fixes

Where possible, provide an error test case that your fix covers.

Features

Please ensure test cases to cover your features.

  1. Include the npm run coverage-test to Running Tests section.
  2. Add a simple tip to run a single test in Running Tests section:

You can also run a single test by performing node ./test/path-to-test-file.


Codecov

I've changed the target from 90% to 89%, because after specifying the exact paths and ensuring that all files are checked, the current score (90.31%) is too close to the limit.

Copy link

codecov bot commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.31%. Comparing base (a9c6c3e) to head (519169c).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2552      +/-   ##
==========================================
- Coverage   91.20%   90.31%   -0.89%     
==========================================
  Files          69       71       +2     
  Lines       15547    15700     +153     
  Branches     1331     1332       +1     
==========================================
  Hits        14179    14179              
- Misses       1368     1521     +153     
Flag Coverage Δ
compression-0 90.31% <ø> (-0.89%) ⬇️
compression-1 90.31% <ø> (-0.89%) ⬇️
tls-0 89.83% <ø> (-0.89%) ⬇️
tls-1 90.13% <ø> (-0.89%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wellwelwel wellwelwel marked this pull request as ready for review April 2, 2024 17:19
@wellwelwel wellwelwel changed the title docs: improve the contribution guide feat(docs): improve the contribution guidelines Apr 2, 2024
@wellwelwel wellwelwel changed the title feat(docs): improve the contribution guidelines fix(docs): improve the contribution guidelines Apr 2, 2024
@wellwelwel
Copy link
Collaborator Author

wellwelwel commented Apr 2, 2024

@sidorares, treating this as a fix to trigger a new release for #2542.

I thought that by changing the PR title, it would automatically update the commit message when it was squashed, but this only applies to multiple commits.

@wellwelwel
Copy link
Collaborator Author

wellwelwel commented Apr 2, 2024

Since it changes the Contributing.md, I'll keep it for you 🙋🏻‍♂️

@sidorares
Copy link
Owner

somehow missed it, lgtm

@sidorares sidorares merged commit 8a818ce into sidorares:master Apr 8, 2024
64 checks passed
@wellwelwel wellwelwel deleted the improve-c8 branch April 9, 2024 09:45
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