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

Link to the change log per #2701 #2714

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Link to the change log per #2701 #2714

wants to merge 1 commit into from

Conversation

dandv
Copy link

@dandv dandv commented Dec 29, 2020

No description provided.

Copy link
Member

@codebrainz codebrainz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think?

Changelog
---------
See the release notes on `the website <https://www.geany.org/documentation/releasenotes/>`_ or `on GitHub <https://github.com/geany/geany/releases>`_.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we could make this change serve double-duty, something like:

Getting Geany
-------------------

The current version of Geany is 1.37 (see `Release Notes here <https://www.geany.org/documentation/releasenotes>`_). Official releases can be found on the `Releases Page <https://www.geany.org/download/releases>`_. Geany is also provided by a number of `Third-Party Packages <https://www.geany.org/download/third-party>`_.

See below for instructions on installing Geany from various release types.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, except I'd leave the "here" out so "Release Notes" matches "Release Page" following.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this more, also because it doesn't mix ChangeLog and ReleaseNotes which is not the same.
If we could omit the version number, the ReadMe doesn't need to be touched on each release.

@@ -27,6 +27,10 @@ The basic features of Geany are:
- embedded terminal emulation
- extensibility through plugins

Changelog
---------
See the release notes on `the website <https://www.geany.org/documentation/releasenotes/>`_ or `on GitHub <https://github.com/geany/geany/releases>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ReleaseNotes and ChangeLog are not the same. The ChangeLog is a generated list from the GIT history, i.e. it contains each commit.
The ReleaseNotes are hand-written highlight changes for each release and much shorter.

IMO nowadays, most people look for what we put in ReleaseNotes and those who want to check every single commit, probably already know how to find the GIT history.

@eht16
Copy link
Member

eht16 commented Sep 12, 2021

@dandv are you still interested in this change?
I think @codebrainz' suggestion is the best (just without the version number :D).

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

Successfully merging this pull request may close these issues.

None yet

4 participants