HDFGroup / HDFGroup/hdfview

CHANGELOG location is inconsistent with HDF5

Open
#463 1 comment 0 reactions 1 assignee Claimed by @mattjala View on GitHub
Component - Documentation
Dominant language
Java
Stars
153
Forks
26
Avg merge
47m
Merged PRs (30d)
1

Description

Ideally, the CHANGELOG.md file would be in `docs` instead of `docs/UserGuide` for consistency with its placement in the HDF5. However, in order to include it in the User Guide, it had to be under the `UserGuide` directory.

One of the following should be done before the next release:
- Move the CHANGELOG to the higher level directory, and remove it from the User Guide
- Move the CHANGELOG to the higher level directory, and somehow embed its contents/a link to it within the User Guide
- Leave the CHANGELOG in its current location

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.