Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use a changelog to keep track of changes instead of having them in the Readme #782

Closed
astrogeco opened this issue Jul 25, 2020 · 0 comments · Fixed by #2159
Closed

Use a changelog to keep track of changes instead of having them in the Readme #782

astrogeco opened this issue Jul 25, 2020 · 0 comments · Fixed by #2159

Comments

@astrogeco
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The version history in the Readme file clutters useful information

Describe the solution you'd like
Move the "version history" from Readme.md to CHANGELOG.md and start following this spec: https://keepachangelog.com/en/1.0.0/

Describe alternatives you've considered
Move changelog section in the readme to a section at the very bottom of the file

Additional context
None

Requester Info
Gerardo E. Cruz-Ortiz, NASA-GSFC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants