Skip to content

Commit 37c3a73

Browse files
lillylaplacelillylaplace
authored
Initial commit
0 parents  commit 37c3a73

File tree

36 files changed

+1538
-0
lines changed

36 files changed

+1538
-0
lines changed

‎.github/pull_request_template/dev-merge_template.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: "🔨 Merge to Dev Template"
3+
about: Create a PR for a merge into the dev branch.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
:point_right: Read the instructions marked with this emoji to guide use of this template. Before submission, delete all the guidance text.
11+
12+
## Changes Made
13+
:point_right: A succinct description of the changes made and to which project component. Delete all guidance text, leaving only the header and the relevant rows in the table below.
14+
15+
| Component | Changes |
16+
| :-- | :-- |
17+
| Literature Review | INSERT TEXT HERE|
18+
| Materials | INSERT TEXT HERE|
19+
| Data Monitoring | INSERT TEXT HERE|
20+
| Preprocessing | INSERT TEXT HERE|
21+
| Other | INSERT TEXT HERE|
22+
23+
## Checklist
24+
:point_right: Check below to confirm you have taken the following steps before submitting this PR:
25+
- [ ] All my proposed changes have been pushed to remote.
26+
- [ ] This pull request is showing as a merge into `dev` (not `main`).
27+
- [ ] I have assigned a specific reviewer for this pull request.
28+
- [ ] I have connected any associated issues to this pull request so they will be automatically closed when the PR is merged. (Do not connect an Epic to a pull request for a merge into `dev`.)
29+
30+
## Notes
31+
:point_right: What additional information should a reviewer know?

‎.github/pull_request_template/main-merge_template.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: 🎁 Merge to Main Template"
3+
about: Create a PR for a merge into the main branch.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
:point_right: Read the instructions marked with this emoji to guide use of this template. Before submission, delete all the guidance text.
11+
12+
## Epic(s) Completed
13+
:point_right: A bulleted list of Epics that will be complete with the merge of this pull request.
14+
15+
## Checklist
16+
:point_right: Check below to confirm you have taken the following steps before submitting this PR:
17+
- [ ] This pull request is showing as a merge into `main`.
18+
- [ ] I have assigned a specific reviewer for this pull request.
19+
- [ ] I have connected any associated Epics to this pull request so they will be automatically closed when the PR is merged.
20+
21+
## Notes
22+
:point_right: What additional information should a reviewer know?

‎.github/workflows/pylint.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Pylint
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
8+
runs-on: ubuntu-latest
9+
strategy:
10+
matrix:
11+
python-version: [3.9]
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up Python ${{ matrix.python-version }}
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: ${{ matrix.python-version }}
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install flake8 notebook
23+
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
24+
- name: Lint with flake8
25+
run: |
26+
flake8 . --ignore=E

‎.gitignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# OS specific files
2+
.DS_Store
3+
4+
# data specific files
5+
derivatives/*
6+
sourcedata/
7+
data-monitoring/ndar/
8+
data-monitoring/*.out

‎CONTRIBUTING.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to [project name]
2+
3+
## Overview
4+
Please note our general guidelines for contributing to NDCLab projects [here](https://ndclab.github.io/wiki/docs/contributing.html).
5+
6+
* [Roadmap](#Roadmap)
7+
* [Directory Structure](#Directory-Structure)
8+
* [Scripts](#Scripts)
9+
* [Containers](#Containers)
10+
* [Workflow](#Workflow)
11+
12+
13+
## Roadmap
14+
Please see the roadmap available on the [README.md](README.md) file of this repository.
15+
16+
:point_right: Keep the "Roadmap" text above but update the link to the `readme` for your repo. And, of course, delete this note before publishing the contributing file.
17+
18+
19+
## Directory Structure
20+
:point_right: Update this section as appropriate for your repo, then delete this note before publishing.
21+
22+
```yml
23+
project-name
24+
├── code
25+
├── containers
26+
├── CONTRIBUTING.md
27+
├── data-monitoring
28+
├──data-monitoring-log.md
29+
├──data-monitoring-protocol.md
30+
├──postprocessing-check
31+
├──results-check
32+
├── derivatives
33+
├──preprocessed
34+
├── literature
35+
├── materials
36+
├──questionnaires
37+
├──task1
38+
├──protocol.md
39+
├──scripts
40+
├──stimuli
41+
├── notebook.md
42+
├── README.md
43+
├── sourcedata
44+
├──checked
45+
├──raw
46+
```
47+
48+
### Container
49+
To ensure reproducibility of results and software, a default docker file and singularity container are included with this template repository. The respective [README.md](README.md) contains a comprehensive guide on how to get started with the dockerfile. A step-by-step guide to getting started also included in the following [video](https://www.youtube.com/watch?v=oO8n3y23b6M).
50+
51+
52+
## Workflow
53+
Workflow for both internal and external lab members is outlined on the [NDCLab contributing wiki page](https://ndclab.github.io/wiki/docs/contributing.html).

0 commit comments

Comments
 (0)