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] Allow LICENSE files to have .txt, .md, or .rst extensions #2036

Merged
merged 4 commits into from
Feb 6, 2025

Conversation

monique2208
Copy link
Contributor

Allow extension for the LICENSE file: #2021

Allow extension for the LICENSE file
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.45%. Comparing base (a2a491d) to head (3eaa005).
Report is 10 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2036   +/-   ##
=======================================
  Coverage   82.45%   82.45%           
=======================================
  Files          17       17           
  Lines        1499     1499           
=======================================
  Hits         1236     1236           
  Misses        263      263           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@effigies effigies changed the title [SCHEMA] Allow extension for the LICENSE file [ENH] Allow LICENSE files to have .txt, .md, or .rst extensions Jan 27, 2025
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.

Please also update:

Templates:
- `dataset_description.json`
- `README[.md|.rst|.txt]`
- `CITATION.cff`
- `CHANGES`
- `LICENSE`

LICENSE:
display_name: License
file_type: regular
description: |
A `LICENSE` file MAY be provided in addition to the short specification of the
used license in the `dataset_description.json` `"License"` field.
The `"License"` field and `LICENSE` file MUST correspond.
The `LICENSE` file MUST be either in ASCII or UTF-8 encoding.
README:
display_name: README
file_type: regular
description: |
A REQUIRED text file, `README`, SHOULD describe the dataset in more detail.
The `README` file MUST be either in ASCII or UTF-8 encoding and MAY have one of the extensions:
`.md` ([Markdown](https://www.markdownguide.org/)),
`.rst` ([reStructuredText](https://docutils.sourceforge.io/rst.html)),
or `.txt`.
A BIDS dataset MUST NOT contain more than one `README` file (with or without extension)
at its root directory.
BIDS does not make any recommendations with regards to the
[Markdown flavor](https://www.markdownguide.org/extended-syntax/#lightweight-markup-languages)
and does not validate the syntax of Markdown and reStructuredText.
The `README` file SHOULD be structured such that its contents can be easily understood
even if the used format is not rendered.
A guideline for creating a good `README` file can be found in the
[bids-starter-kit](https://github.com/bids-standard/bids-starter-kit/tree/main/templates/).

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.

LGTM. Thanks!

@effigies effigies merged commit 0a8f910 into bids-standard:master Feb 6, 2025
27 checks passed
@effigies
Copy link
Collaborator

effigies commented Feb 6, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants