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.

Sign up for GitHub

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

Jump to bottom

consolidate documentation on running tests #1248

Merged
merged 1 commit into from
Jan 6, 2025
Merged

consolidate documentation on running tests #1248

merged 1 commit into from
Jan 6, 2025

Conversation

jakob-keller
Copy link
Collaborator

Description of Change

Consolidate documentation on running tests.

Assumptions

Documentation on running tests should be moved from README.rst (and PyPI page) to CONTRIBUTING.rst.

Checklist for All Submissions

  • I have added change info to CHANGES.rst
  • If this is resolving an issue (needed so future developers can determine if change is still necessary and under what conditions) (can be provided via link to issue with these details): closes Duplicate and possibly outdated documentation on running tests #1247
    • Detailed description of issue
    • Alternative methods considered (if any)
    • How issue is being resolved
    • How issue can be reproduced
  • If this is providing a new feature (can be provided via link to issue with these details):
    • Detailed description of new feature
    • Why needed
    • Alternatives methods considered (if any)

Checklist when updating botocore and/or aiohttp versions

  • I have read and followed CONTRIBUTING.rst
  • I have updated test_patches.py where/if appropriate (also check if no changes necessary)
  • I have ensured that the awscli/boto3 versions match the updated botocore version

@jakob-keller jakob-keller added the documentation Improvements or additions to documentation label Dec 29, 2024
@jakob-keller jakob-keller self-assigned this Dec 29, 2024
@codecov Codecov
Copy link

codecov bot commented Dec 29, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.04%. Comparing base (9647083) to head (3cebe6b).
Report is 2 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #1248      +/-   ##
==========================================
+ Coverage   87.99%   88.04%   +0.05%     
==========================================
  Files          67       67              
  Lines        5904     5904              
==========================================
+ Hits         5195     5198       +3     
+ Misses        709      706       -3
Flag Coverage Δ
unittests 88.04% <ø> (+0.05%) ⬆️

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.

@jakob-keller jakob-keller added this pull request to the merge queue Jan 6, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Jan 6, 2025
@jakob-keller jakob-keller enabled auto-merge January 6, 2025 19:40
@jakob-keller jakob-keller added this pull request to the merge queue Jan 6, 2025
Merged via the queue into aio-libs:master with commit 22d3e7c Jan 6, 2025
11 checks passed
@jakob-keller jakob-keller deleted the running-tests-docs branch January 6, 2025 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thehesiod thehesiod Awaiting requested review from thehesiod

Assignees

@jakob-keller jakob-keller

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Duplicate and possibly outdated documentation on running tests
1 participant
@jakob-keller