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

refactor: Relocated test/ to tests/ and made contribution process easier #598

Merged
merged 19 commits into from
Nov 12, 2021

Conversation

fg-mindee
Copy link
Contributor

@fg-mindee fg-mindee commented Nov 9, 2021

This PR introduces the following modifications:

  • moved test/ to tests/
  • added new extras in setup.py
  • added Makefile for easier development procedure (from the repo folder, running make test will run all the CI unittests, make quality will run all style checks, and make docs will build the documentation)
  • updates CONTRIBUTING, CI accordingly
  • added a unittest for dependency consistency check (checking that we have the exact same version constraint between setup.py and all requirements.txt)

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement topic: build Related to dependencies and build topic: ci Related to CI ext: tests Related to tests folder labels Nov 9, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Nov 9, 2021
@fg-mindee fg-mindee self-assigned this Nov 9, 2021
charlesmindee
charlesmindee previously approved these changes Nov 10, 2021
Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

thanks!

@codecov
Copy link

codecov bot commented Nov 10, 2021

Codecov Report

Merging #598 (3e41682) into main (f537551) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #598   +/-   ##
=======================================
  Coverage   96.03%   96.03%           
=======================================
  Files         110      110           
  Lines        4264     4265    +1     
=======================================
+ Hits         4095     4096    +1     
  Misses        169      169           
Flag Coverage Δ
unittests 96.03% <ø> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
doctr/datasets/detection.py 96.96% <0.00%> (ø)
doctr/datasets/recognition.py 92.00% <0.00%> (ø)
doctr/models/predictor/tensorflow.py 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f537551...3e41682. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@fg-mindee fg-mindee merged commit eb5db48 into main Nov 12, 2021
@fg-mindee fg-mindee deleted the test-relocation branch November 12, 2021 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: tests Related to tests folder topic: build Related to dependencies and build topic: ci Related to CI topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants