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

Add codespell and fix few typos #86

Merged
merged 4 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git*,go.sum,i18n,*.css,.codespellrc
check-hidden = true
# lines with names in publications
ignore-regex = (^- (name|.*\bdoi):.*|fnndsc\.childrens\.harvard\.edu)
# ignore-words-list =
25 changes: 25 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Annotate locations with typos
uses: codespell-project/codespell-problem-matcher@v1
- name: Codespell
uses: codespell-project/actions-codespell@v2
4 changes: 2 additions & 2 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Code of Conduct

The ReproNIM orginization is dedicated to providing an environment where people are kind and respectful to each other, a harassment-free learning experience for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age or religion.
The ReproNIM organization is dedicated to providing an environment where people are kind and respectful to each other, a harassment-free learning experience for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age or religion.
We do not tolerate harassment in any form.
Sexual language and imagery is not appropriate for any ReproNIM event, including meetings, workshops, and online forums.
Participants violating these rules may be sanctioned or expelled from participation in the group at the discretion of the organizers.

### Harrassment
### Harassment

⛔ Harassment includes, but _is not limited to_:

Expand Down
2 changes: 1 addition & 1 deletion content/resources/tutorials/data-management-and-sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ We also provide some guidance on preparing a DMSP budget for implementing the pl
3. **Metadata, other relevant data, and associated documentation:**

* **Study protocols**: We recommend pre-registering the study protocol using a platform such as the Open Science Framework (osf.io). Pre-registering your study design, including planned outcome measures, increases transparency and accountability.
* **Associate relevant metadata with both imaging and behavioral raw data**. Using BIDS and NIDM provides the means to associate metadata with imaging raw data. Use ReproSchema to prospectively create a re-usable schema for structured behavioral data capture. Use NeuroBagel to annotate behavioral data retrospectively.
* **Associate relevant metadata with both imaging and behavioral raw data**. Using BIDS and NIDM provides the means to associate metadata with imaging raw data. Use ReproSchema to prospectively create a reusable schema for structured behavioral data capture. Use NeuroBagel to annotate behavioral data retrospectively.
* **Data dictionary:**
* **Good**: Create a data dictionary to define your variables. (provide a link to examples)
* **Best:** Use NIDM to create or map the data dictionary to standard variable names and value sets. NIDM also provides additional semantics, i.e., the necessary human knowledge for both humans and machines to interpret and relate data elements. NIDM utilizes community ontologies to provide this knowledge in the form of a common vocabulary and relationships between terms, e.g., Freesurfer variable *caudate\_left\_volume* maps to the term “caudate nucleus” in the UBERON anatomical ontology. Caudate nucleus is part of the striatum and telencephalon.
Expand Down
Loading