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

Streamline change history in ReadMe #1581

Open
astrogeco opened this issue May 26, 2021 · 1 comment
Open

Streamline change history in ReadMe #1581

astrogeco opened this issue May 26, 2021 · 1 comment
Labels
docs This change only affects documentation.

Comments

@astrogeco
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The changelog history clutters the ReadMe.

Describe the solution you'd like
Move all change history to a new CHANGELOG.md. Replace "History" section on ReadMe with a "Changes in Latest Build" section that contains the latest entry in the changelog.

Describe alternatives you've considered
Automatically generating the changelog. Stop including the change summary in the ReadMe.

Additional context
None

@astrogeco astrogeco changed the title Create a changelog file Streamline change history in ReadMe May 26, 2021
@skliper
Copy link
Contributor

skliper commented May 26, 2021

Recommending just a high level summary in the ReadMe (major changes in current and previous development cycles, a couple lines per release/cycle) as more valuable than the latest changelog entry. Only needs to be updated when major changes happen. Just reference the CHANGELOG for details.

@skliper skliper added the docs This change only affects documentation. label Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation.
Projects
None yet
Development

No branches or pull requests

2 participants