Skip to content

Commit 66d3491

Browse files
authored
Merge pull request #118 from yarikoptic/enh-misc2
ENH: initial CHANGELOG.md, and .mailmap (for your git shortlog -sn needs ;) )
2 parents 5c86a78 + 7b98fb8 commit 66d3491

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

.mailmap

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
Matteo Visconti di Oleggio Castello <[email protected]>
3+
Matteo Visconti di Oleggio Castello <[email protected]>
4+
Matteo Visconti di Oleggio Castello <[email protected]>
5+
Chris Filo Gorgolewski <[email protected]> Chris Gorgolewski <[email protected]>

CHANGELOG.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Changelog
2+
All notable changes to this project will be documented (for humans) in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [0.5] - TBD
8+
First release after major refactor
9+
### Added
10+
- [CHANGELOG.md](https://github.com/nipy/heudiconv/blob/master/CHANGELOG.md)
11+
- [Regression testing](https://github.com/nipy/heudiconv/blob/master/tests/test_regression.py) on real data (using datalad)
12+
### Changed
13+
- Refactored into a proper `heudiconv` Python module
14+
- `Dockerfile` is generated by [neurodocker](https://github.com/kaczmarj/neurodocker)
15+
- Logging verbosity reduced
16+
- Increased leniency with missing DICOM fields
17+
### Removed
18+
### Deprecated
19+
### Fixed
20+
- Consistency with converted files permissions
21+
- Ensured subject id for BIDS conversions will be BIDS compliant
22+
- Re-add `seqinfo` fields as column names in generated `dicominfo`
23+
### Security
24+
25+
## [0.4] - 2017-10-15
26+
A usable release to support [DBIC] use-case
27+
### Added
28+
- more testing
29+
### Changes
30+
- Dockerfile updates (added pigz, progressed forward [dcm2niix])
31+
### Fixed
32+
- correct date/time in BIDS `_scans` files
33+
- sort entries in `_scans` by date and then filename
34+
35+
## [0.3] - 2017-07-10
36+
A somewhat working release on the way to support [DBIC] use-case
37+
### Added
38+
- more tests
39+
- groupping of dicoms by series if provided
40+
- many more features and fixes
41+
42+
## [0.2] - 2016-10-20
43+
An initial release on the way to support [DBIC] use-case
44+
### Added
45+
- basic Python project assets (`setup.py`, etc)
46+
- basic tests
47+
- [datalad] support
48+
- dbic_bids heuristic
49+
- `--dbg` command line flag to enter `pdb` environment upon failure
50+
## Fixed
51+
- Better Python3 support
52+
- Better PEP8 compliance
53+
54+
## [0.1] - 2015-09-23
55+
56+
Initial version
57+
58+
---
59+
60+
Just a template for future records:
61+
62+
## [Unreleased] - Date
63+
TODO Summary
64+
### Added
65+
### Changed
66+
### Deprecated
67+
### Fixed
68+
### Removed
69+
### Security
70+
71+
---
72+
73+
## References
74+
[DBIC]: http://dbic.dartmouth.edu
75+
[datalad]: http://datalad.org
76+
[dcm2niix]: https://github.com/rordenlab/dcm2niix

0 commit comments

Comments
 (0)