generated from NDCLab/template-dataset
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit cdc42ac
Showing
34 changed files
with
1,495 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: "🔨 Merge to Dev Template" | ||
about: Create a PR for a merge into the dev branch. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
:point_right: Read the instructions marked with this emoji to guide use of this template. Before submission, delete all the guidance text. | ||
|
||
## Changes Made | ||
: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. | ||
|
||
| Component | Changes | | ||
| :-- | :-- | | ||
| Literature Review | INSERT TEXT HERE| | ||
| Materials | INSERT TEXT HERE| | ||
| Data Monitoring | INSERT TEXT HERE| | ||
| Preprocessing | INSERT TEXT HERE| | ||
| Other | INSERT TEXT HERE| | ||
|
||
## Checklist | ||
:point_right: Check below to confirm you have taken the following steps before submitting this PR: | ||
- [ ] All my proposed changes have been pushed to remote. | ||
- [ ] This pull request is showing as a merge into `dev` (not `main`). | ||
- [ ] I have assigned a specific reviewer for this pull request. | ||
- [ ] 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`.) | ||
|
||
## Notes | ||
:point_right: What additional information should a reviewer know? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
name: 🎁 Merge to Main Template" | ||
about: Create a PR for a merge into the main branch. | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
:point_right: Read the instructions marked with this emoji to guide use of this template. Before submission, delete all the guidance text. | ||
|
||
## Epic(s) Completed | ||
:point_right: A bulleted list of Epics that will be complete with the merge of this pull request. | ||
|
||
## Checklist | ||
:point_right: Check below to confirm you have taken the following steps before submitting this PR: | ||
- [ ] This pull request is showing as a merge into `main`. | ||
- [ ] I have assigned a specific reviewer for this pull request. | ||
- [ ] I have connected any associated Epics to this pull request so they will be automatically closed when the PR is merged. | ||
|
||
## Notes | ||
:point_right: What additional information should a reviewer know? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
name: Pylint | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
build: | ||
|
||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: [3.9] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install flake8 notebook | ||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | ||
- name: Lint with flake8 | ||
run: | | ||
flake8 . --ignore=E |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# OS specific files | ||
.DS_Store | ||
|
||
# data specific files | ||
derivatives/* | ||
sourcedata/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to [project name] | ||
|
||
## Overview | ||
Please note our general guidelines for contributing to NDCLab projects [here](https://ndclab.github.io/wiki/docs/contributing.html). | ||
|
||
* [Roadmap](#Roadmap) | ||
* [Directory Structure](#Directory-Structure) | ||
* [Scripts](#Scripts) | ||
* [Containers](#Containers) | ||
* [Workflow](#Workflow) | ||
|
||
|
||
## Roadmap | ||
Please see the roadmap available on the [README.md](README.md) file of this repository. | ||
|
||
: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. | ||
|
||
|
||
## Directory Structure | ||
:point_right: Update this section as appropriate for your repo, then delete this note before publishing. | ||
|
||
```yml | ||
project-name | ||
├── code | ||
├── containers | ||
├── CONTRIBUTING.md | ||
├── data-monitoring | ||
├──data-monitoring-log.md | ||
├──data-monitoring-protocol.md | ||
├──postprocessing-check | ||
├──results-check | ||
├── derivatives | ||
├──preprocessed | ||
├── literature | ||
├── materials | ||
├──questionnaires | ||
├──task1 | ||
├──protocol.md | ||
├──scripts | ||
├──stimuli | ||
├── notebook.md | ||
├── README.md | ||
├── sourcedata | ||
├──checked | ||
├──raw | ||
``` | ||
|
||
### Container | ||
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). | ||
|
||
|
||
## Workflow | ||
Workflow for both internal and external lab members is outlined on the [NDCLab contributing wiki page](https://ndclab.github.io/wiki/docs/contributing.html). |
Oops, something went wrong.