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

docs(CONTRIBUTING): add tests section #392

Merged

Conversation

svaloumas
Copy link
Collaborator

Description

This PR adds a minimal Tests section in the CONTRIBUTING.md.

Motivation and Context

We need to document somewhere the process of uniformly generating mocks and the CONTRIBUTING.md might be a good place to do so. In addition, this section could be used to add more about our test conventions/guidelines or any other related information in the future.

How Has This Been Tested?

Screenshots / Output (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Sep 16, 2022

Codecov Report

Base: 63.55% // Head: 63.55% // No change to project coverage 👍

Coverage data is based on head (e709c49) compared to base (0c3d986).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #392   +/-   ##
=======================================
  Coverage   63.55%   63.55%           
=======================================
  Files          30       30           
  Lines        1029     1029           
=======================================
  Hits          654      654           
  Misses        316      316           
  Partials       59       59           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@nikoksr nikoksr merged commit 4721e74 into nikoksr:main Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants