Skip to content

Add QA/QC community practices document - #24

Merged
RayStick merged 19 commits into
masterfrom
qa_qc
Oct 23, 2026
Merged

Add QA/QC community practices document#24
RayStick merged 19 commits into
masterfrom
qa_qc

Conversation

@RayStick

@RayStick RayStick commented Aug 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

The QA/QC community practices section is ready for a first review round 🎉

Context for reviewers the content of this document was sourced from community discussions on QA/QC during community best practices meetings. People contributing to these meetings (or the subsequent write up of the notes) have been tagged in this first review. A second review will go out to the wider community later. Any questions, don't hesitate to ask.

Closes #17

Proposed Changes

  • Add qa_qc.md: content of the 24.12.19: Best practices in QA/QC community meeting
  • Update the index.rst file to add the qa_qc page
  • Update the references.md file to add the overview of the community meeting and the cited references

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@RayStick RayStick self-assigned this Aug 20, 2026
@RayStick
RayStick requested review from m-miedema and me-pic August 20, 2026 15:58
@RayStick RayStick changed the title Create qa_qc.md Add QA/QC community practices document Aug 20, 2026
@me-pic @RayStick
@isesteves @goodalse2019 @m-miedema
Add QA/QC community practices
cf687ed 
Co-authored-by: RayStick <50215726+RayStick@users.noreply.github.com>
Co-authored-by: isesteves <24605642+isesteves@users.noreply.github.com>
Co-authored-by: Sarah Goodale <60117796+goodalse2019@users.noreply.github.com>
Co-authored-by: m-miedema <39968233+m-miedema@users.noreply.github.com>
@github-actions github-actions Bot added Documentation This issue or PR is about the documentation Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog labels Aug 28, 2026
@m-miedema
m-miedema marked this pull request as ready for review September 1, 2026 01:02
@RayStick RayStick added the Majormod This PR breaks compatibility, and increments the major version (+1.0.0) label Sep 1, 2026
@smoia

smoia commented Sep 14, 2026

Copy link
Copy Markdown
Member

Small note - the automatic release on Majormod would bump version to 2025, while we need to release at 2026.0.0.

I'd suggest a manual release for this.

@RayStick RayStick removed the Majormod This PR breaks compatibility, and increments the major version (+1.0.0) label Sep 14, 2026
@RayStick

RayStick commented Sep 14, 2026

Copy link
Copy Markdown
Member Author

Small note - the automatic release on Majormod would bump version to 2025, while we need to release at 2026.0.0.

I'd suggest a manual release for this.

Okay thanks - removed the Majormod label then

@smoia smoia removed the Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog label Sep 14, 2026
@smoia smoia added the Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog label Sep 14, 2026
beccaclements99
beccaclements99 approved these changes Sep 15, 2026
View reviewed changes

@beccaclements99 beccaclements99 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great!

mrikasper
mrikasper approved these changes Oct 5, 2026
View reviewed changes

@mrikasper mrikasper left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great work! I have a couple of comments, which I am happy to provide change requests/commits myself, but I didn't want to slow down the process here and was not sure whether you preferred to have comments first or accompany them by change suggestions right away.

None of my comments are major concerns, therefore: approved!

Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
BrightMG
BrightMG approved these changes Oct 6, 2026
View reviewed changes
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md Outdated
Comment thread docs/source/qa_qc.md
Comment thread docs/source/qa_qc.md Outdated
@RayStick @mrikasper
remove extra space
a6e9274 
Co-authored-by: Lars Kasper <Lars.Kasper@utoronto.ca>
rgbayrak
rgbayrak approved these changes Oct 9, 2026
View reviewed changes

@rgbayrak rgbayrak left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM!

@m-miedema m-miedema mentioned this pull request Oct 12, 2026
Open
RayStick and others added 4 commits October 13, 2026 08:35
@RayStick
Update qa_qc.md
31e6ddf 
As suggested by Lars and Marie-Eve
@RayStick @mrikasper
wording clarity
cac507f 
Co-authored-by: Lars Kasper <Lars.Kasper@utoronto.ca>
@RayStick
remove unwanted space
10b91f4
@RayStick
Update qa_qc.md
12d866e 
Wording changes from Lars
This was referenced Oct 19, 2026
Open
Open
@RayStick
Add sub-headings
2b6bb9c 
As suggested by Lars
@RayStick
Update qa_qc.md
83993d3 
Rewording suggestion from Molly and Lars
@RayStick
Update qa_qc.md
5a8a940 
Add example suggested by Lars
@RayStick
Update qa_qc.md
67fcd43 
Clarity added, as suggested by Lars
@RayStick
Update qa_qc.md
878ca77 
As suggested in this thread: #24 (comment)
@RayStick RayStick mentioned this pull request Oct 19, 2026
Open
@RayStick
Update qa_qc.md
c8e6efd 
Mention of whole time-series as suggested by Molly
@RayStick RayStick mentioned this pull request Oct 19, 2026
Open
me-pic
me-pic reviewed Oct 20, 2026
View reviewed changes
Comment thread docs/source/qa_qc.md Outdated
RayStick and others added 4 commits October 22, 2026 19:11
@RayStick @me-pic
Update docs/source/qa_qc.md
df88960 
Co-authored-by: Marie-Eve Picard <marie-eve.picard.2@umontreal.ca>
@RayStick
Consistent spelling
511a801
@me-pic @mrikasper
Add reference qa_qc.md.
9a6a779 
Co-authored-by: Lars Kasper <Lars.Kasper@utoronto.ca>
@me-pic
Update qa_qc.md
4641eb1 
Clarify the quality assurance, quality assessment and quality control terminology as per Roza's suggestion
@RayStick RayStick mentioned this pull request Oct 23, 2026
Open
@RayStick

RayStick commented Oct 23, 2026

Copy link
Copy Markdown
Member Author

We have resolved all the comments (either made corrections to the text or added them as Issues under this milestone: https://github.com/physiopy/physiopy-community-practices/milestone/1). As every reviewer approved the changes, and none of the latest edits were too substantial, I am merging these changes now.

Next steps (after the merge) will be:

  1. Check version labels on GitHub repo and read-the-doc pages are updated appropriately
  2. Check the page listing the contributors are up to date (https://physiopy-community-practices.readthedocs.io/en/latest/physiopy_community.html#community-practices-meetings-contributors)
  3. Plan to tackle https://github.com/physiopy/physiopy-community-practices/milestone/1

@RayStick
RayStick merged commit d9c6119 into master Oct 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m-miedema m-miedema m-miedema approved these changes
@me-pic me-pic me-pic approved these changes
@isesteves isesteves isesteves approved these changes
@smoia smoia smoia approved these changes
@beccaclements99 beccaclements99 beccaclements99 approved these changes
@goodalse2019 goodalse2019 Awaiting requested review from goodalse2019
@SRSteinkamp SRSteinkamp Awaiting requested review from SRSteinkamp
@celprov celprov Awaiting requested review from celprov
+4 more reviewers
@mrikasper mrikasper mrikasper approved these changes
@rgbayrak rgbayrak rgbayrak approved these changes
@BrightMG BrightMG BrightMG approved these changes
@ShiyuBelleWang ShiyuBelleWang ShiyuBelleWang approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@RayStick RayStick

Labels

Documentation This issue or PR is about the documentation Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Integrate physio qc notes in community practices

10 participants

@RayStick @smoia @mrikasper @isesteves @rgbayrak @BrightMG @m-miedema @me-pic @beccaclements99 @ShiyuBelleWang