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

Add a CHANGELOG.md & adopt a formatting convention for release notes #663

Closed
virtualtam opened this issue Oct 16, 2016 · 2 comments
Closed

Comments

@virtualtam
Copy link
Member

virtualtam commented Oct 16, 2016

See http://keepachangelog.com/en/0.3.0/

Proposition:

  • adopt a formatting convention for our release notes
  • provide a Markdown-formatted CHANGELOG with the full release history

This will help maintainers, users, plugin and template developers to:

  • keep track of important changes happening on the Shaarli codebase and documentation
  • get this information locally, without need to browse release notes on GitHub

As we're going towards major changes, I think it becomes important to know in a glance which features have been deprecated or removed, and where to find updated configuration/upgrade instructions.

I've already started to refactor pre-v0.5.0 release notes, and wrote a Python script to programmatically generate a Markdown CHANGELOG from GitHub release notes so we have a starting point.

@ArthurHoaro
Copy link
Member

OK, this format doesn't have too many constraints. 👍

@virtualtam
Copy link
Member Author

Cool, I'll update the remaining release notes and submit a PR with the resulting change log ;-)

virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 17, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

This file mirrors the content of the Shaarli release notes available at
https://github.com/shaarli/Shaarli/releases

Signed-off-by: VirtualTam <[email protected]>
@virtualtam virtualtam mentioned this issue Oct 17, 2016
9 tasks
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 17, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

These entries correspond to the first lightweight tags present on the
Shaarli Community repository. As there are no corresponding release (notes),
the changelog is based on relevant elements from the Git commit log.

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 17, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

These entries correspond to the original (legacy) Shaarli release
notes by Sebsauvage.

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 17, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

These entries correspond to the original (legacy) Shaarli release
notes by Sebsauvage.

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 17, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

Modifications:
- keep 2 newlines between each release section
- keep reasonable line lengths (< 90 characters)
- remove extra final dots (only kept when there are several sentences)
- fix typos
- reword/rewrite/curate legacy changelog entries

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

This file mirrors the content of the Shaarli release notes available at
https://github.com/shaarli/Shaarli/releases

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

These entries correspond to the first lightweight tags present on the
Shaarli Community repository. As there are no corresponding release (notes),
the changelog is based on relevant elements from the Git commit log.

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

Modifications:
- keep 2 newlines between each release section
- keep reasonable line lengths (< 90 characters)
- remove extra final dots (only kept when there are several sentences)
- fix typos
- reword/rewrite/curate legacy changelog entries

Signed-off-by: VirtualTam <[email protected]>
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
virtualtam added a commit to virtualtam/Shaarli that referenced this issue Oct 18, 2016
virtualtam added a commit to shaarli/netscape-bookmark-parser that referenced this issue Nov 2, 2016
ArthurHoaro pushed a commit that referenced this issue Nov 5, 2016
Relates to #663
See http://keepachangelog.com/en/0.3.0/

This file mirrors the content of the Shaarli release notes available at
https://github.com/shaarli/Shaarli/releases

Signed-off-by: VirtualTam <[email protected]>
ArthurHoaro pushed a commit that referenced this issue Nov 5, 2016
Relates to #663
See http://keepachangelog.com/en/0.3.0/

These entries correspond to the first lightweight tags present on the
Shaarli Community repository. As there are no corresponding release (notes),
the changelog is based on relevant elements from the Git commit log.

Signed-off-by: VirtualTam <[email protected]>
ArthurHoaro pushed a commit that referenced this issue Nov 5, 2016
Relates to #663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

Modifications:
- keep 2 newlines between each release section
- keep reasonable line lengths (< 90 characters)
- remove extra final dots (only kept when there are several sentences)
- fix typos
- reword/rewrite/curate legacy changelog entries

Signed-off-by: VirtualTam <[email protected]>
ArthurHoaro pushed a commit that referenced this issue Nov 5, 2016
portailp pushed a commit to PortailPro/Shaarli that referenced this issue Mar 20, 2017
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

This file mirrors the content of the Shaarli release notes available at
https://github.com/shaarli/Shaarli/releases

Signed-off-by: VirtualTam <[email protected]>
portailp pushed a commit to PortailPro/Shaarli that referenced this issue Mar 20, 2017
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/

These entries correspond to the first lightweight tags present on the
Shaarli Community repository. As there are no corresponding release (notes),
the changelog is based on relevant elements from the Git commit log.

Signed-off-by: VirtualTam <[email protected]>
portailp pushed a commit to PortailPro/Shaarli that referenced this issue Mar 20, 2017
portailp pushed a commit to PortailPro/Shaarli that referenced this issue Mar 20, 2017
Relates to shaarli#663
See http://keepachangelog.com/en/0.3.0/
See http://sebsauvage.net/wiki/doku.php?id=php:shaarli:history

Modifications:
- keep 2 newlines between each release section
- keep reasonable line lengths (< 90 characters)
- remove extra final dots (only kept when there are several sentences)
- fix typos
- reword/rewrite/curate legacy changelog entries

Signed-off-by: VirtualTam <[email protected]>
portailp pushed a commit to PortailPro/Shaarli that referenced this issue Mar 20, 2017
virtualtam added a commit to shaarli/devtools that referenced this issue Oct 4, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants