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

[ENH] clarify guiding principles for requirement levels #1444

Merged
merged 2 commits into from
Mar 24, 2023

Conversation

sappelhoff
Copy link
Member

closes #1422

@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (8f21b45) 88.01% compared to head (a7397f5) 88.01%.

❗ Current head a7397f5 differs from pull request most recent head 1c5e9e2. Consider uploading reports for the commit 1c5e9e2 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1444   +/-   ##
=======================================
  Coverage   88.01%   88.01%           
=======================================
  Files          14       14           
  Lines        1268     1268           
=======================================
  Hits         1116     1116           
  Misses        152      152           

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 in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@effigies
Copy link
Collaborator

Cross-posting from #1439:

[It] seems these could go in either the spec or the contributing guide. I'm slightly in favor of having spec-writing "principles" in the contributing guide as they have no effect on the interpretation of the spec or a dataset, but I would not attempt to block this.

@sappelhoff
Copy link
Member Author

Fair point that it has no effect on the interpretation, but it does add some context and may make it easier for readers to think about the requirement levels. Having that said, I am also not absolutely convinced that it HAS to go in the spec. As long as we have it somewhere.

@sappelhoff sappelhoff added this to the 1.9.0 milestone Mar 20, 2023
Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

I have slight preference to have it in the spec if only because contributing if more contributors facing and less user facing.

I would say that this PR actually falls under the "interpretation" category.

Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

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

I'm okay with this.

src/common-principles.md Outdated Show resolved Hide resolved
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[EASY/DOC] Document the reasoning around requirement levels in BIDS
3 participants