Commit 1013765a authored by Hueser, Christian (FWCC) - 138593's avatar Hueser, Christian (FWCC) - 138593
Browse files

Adapt file CHANGELOG to document changes made during developments

* Adapt file CHANGELOG with regard to past developments to have proper documentation of what the actual changes are in each version of the project.
parent 294e9825
Pipeline #77668 failed with stages
in 1 minute and 29 seconds
......@@ -33,15 +33,108 @@ Group your changes into these categories:
## Unreleased
### Added
- ABC for plotters
- matplotlib plotter
- printer module
- data payload for example scripts
## [1.0.0](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/releases/v1.0.0) - 2021-06-18
[List of commits](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/compare/v0.3.0...v1.0.0)
### Added
- Added an external configuration file to set defaults for an analysis run
([!64](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/64)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Create files CONTRIBUTING, CHANGELOG, VERSION and adapt file README
([!66](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/66)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Refactor internal structure for OOP-style and add an example analysis script
([!67](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/67)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add unit test cases for module `data_container`
([!85](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/85)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `question_collection`
([!80](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/80)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `answer_option`
([!83](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/83)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add unit test cases for module `question`
([!82](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/82)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Refactor models and adapt them to changed metadata structure and elements
([!72](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/72)
by [erxleb87](https://gitlab.hzdr.de/erxleb87)).
- Add unit test cases for module `settings`
([!76](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/76)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Detect CSV files with gitleaks which is part of the tool SQA
([!74](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/74)
by [Normo](https://gitlab.hzdr.de/Normo)).
- Add file `License.md` to provide license information of the project
([!90](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/90)
by [Normo](https://gitlab.hzdr.de/Normo)).
- Create a getting started guide for the project
([!84](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/84)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Split up object routed to analysis scripts into data container and analysis objects
([!91](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/91)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add capabilities to add a data preprocessing script to the project
([!92](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/92)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Add URLs of project to file `pyproject.toml` for PyPi.org
([!73](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/73)
by [Normo](https://gitlab.hzdr.de/Normo)).
- Add URL of project documentation to file `pyproject.toml` for PyPi.org
([!94](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/94)
by [Normo](https://gitlab.hzdr.de/Normo)).
### Changed
- internal structure
- interface to the analysis scripts
- Change Makefile and GitLab CI pipeline
([!68](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/68)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Improve inline documentation and API documentation
([!69](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/69)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Replace default branch names in GitLab CI pipeline with variable `CI_DEFAULT_BRANCH`
([!89](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/89)
by [Normo](https://gitlab.hzdr.de/Normo)).
- Generate and publish project documentation on merges into default branch `main`
([!93](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/93)
by [Normo](https://gitlab.hzdr.de/Normo)).
- Adapt file CHANGELOG to document changes made during the developments
([!95](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/95)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
### Fixed
- internal data handling
\ No newline at end of file
- Enable GitLab CI job trigger to run on merges into default branch
([!70](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/70)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Fix infinite recursion in method `add_answer` in module `question`
([!81](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/81)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
- Add missing `__init__.py` files to unit test case packages
([!87](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/87)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
## [0.3.0](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/releases/v0.3.0) - 2021-04-22
[List of commits](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/compare/v0.1.0...v0.3.0)
### Added
- Add SQA tool for software quality assessments during GitLab CI pipeline
([!60](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/60)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Publish project on PyPi.org as `hifis-surveyval`
([!63](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/63)
by [hueser93](https://gitlab.hzdr.de/hueser93)).
### Changed
- Replace Pipenv by Poetry and add file `pyproject.toml` to project
([!59](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/59)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
- Rename project to `HIFIS-Surveyval`
([!62](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/merge_requests/62)
by [mdolling-gfz](https://gitlab.hzdr.de/mdolling-gfz)).
## [0.1.0](https://gitlab.hzdr.de/hifis/surveys/hifis-surveyval/-/releases/v0.1.0) - 2021-04-12
- Initial version of the project.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment