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

DOC: Add design document on Tests and CI #7195

Merged
merged 6 commits into from
Nov 24, 2022
Merged

Conversation

adswa
Copy link
Member

@adswa adswa commented Nov 21, 2022

This fixes #6679 by moving the CONTRIBUTING section on migrating downstream code from nose to pytest into a dedicated Design document in the docs.

I just moved this section because there was an explicit issue about it, but if deemed useful, this new design document could contain more test-related information from contributing, and become a more general Design doc on tests and CI - what do you think?

[skip ci]

@adswa adswa added documentation Documentation-related issue semver-documentation Changes only affect the documentation, no impact on version and removed documentation Documentation-related issue labels Nov 21, 2022
@bpoldrack
Copy link
Member

if deemed useful, this new design document could contain more test-related information from contributing, and become a more general Design doc on tests and CI - what do you think?

I think, that would be awesome! :)

@adswa adswa changed the title DOC: Move pytest migration docs from CONTRIBUING into docs DOC: Add design document on Tests and CI Nov 21, 2022
@adswa adswa added the help wanted Someone else is requested to take over label Nov 21, 2022
@codecov
Copy link

codecov bot commented Nov 21, 2022

Codecov Report

Base: 88.63% // Head: 52.29% // Decreases project coverage by -36.33% ⚠️

Coverage data is based on head (83b1eaf) compared to base (90cf7f3).
Patch has no changes to coverable lines.

❗ Current head 83b1eaf differs from pull request most recent head ee8a311. Consider uploading reports for the commit ee8a311 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #7195       +/-   ##
===========================================
- Coverage   88.63%   52.29%   -36.34%     
===========================================
  Files         325      325               
  Lines       44109    43584      -525     
  Branches     5863     5863               
===========================================
- Hits        39096    22793    -16303     
- Misses       4998    20682    +15684     
- Partials       15      109       +94     
Impacted Files Coverage Δ
datalad/tests/test_cmd.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/tests/test_base.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/tests/test_misc.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/ui/tests/__init__.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/runner/tests/utils.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/tests/test__main__.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/tests/test_strings.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/ui/tests/test_base.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/tests/test_testrepos.py 0.00% <0.00%> (-100.00%) ⬇️
datalad/cli/tests/test_parser.py 0.00% <0.00%> (-100.00%) ⬇️
... and 235 more

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.

Copy link
Member

@yarikoptic yarikoptic left a comment

Choose a reason for hiding this comment

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

THANK YOU! Left some comments

CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/source/design/testing.rst Outdated Show resolved Hide resolved
docs/source/design/testing.rst Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@adswa adswa added the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Nov 22, 2022
for better control/smaller likelihood to accidentally run
a systemwide pytest or datalad installation

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

Update CONTRIBUTING.md

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

Update docs/source/design/testing.rst

Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>

[skip ci]
@github-actions github-actions bot removed the CHANGELOG-missing When a PR's description does not contain a changelog item, yet. label Nov 22, 2022
- improved descriptions of file layouts for tests
- removed mention of nose-based utils

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

Update docs/source/design/testing.rst

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

Update docs/source/design/testing.rst

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

Update docs/source/design/testing.rst

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

Update docs/source/design/testing.rst

Co-authored-by: Benjamin Poldrack <bpoldrack@users.noreply.github.com>

[skip ci]
@codeclimate
Copy link

codeclimate bot commented Nov 22, 2022

Code Climate has analyzed commit ee8a311 and detected 0 issues on this pull request.

View more on Code Climate.

@bpoldrack
Copy link
Member

Ok, let's go with this for now. Thank you @adswa!

@bpoldrack bpoldrack merged commit 66b5854 into datalad:master Nov 24, 2022
@adswa adswa deleted the doc-pytest branch November 24, 2022 08:56
@yarikoptic-gitmate
Copy link
Collaborator

PR released in 0.18.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Someone else is requested to take over semver-documentation Changes only affect the documentation, no impact on version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants