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

Update README.md v5.25.0 #176

Closed
wants to merge 5 commits into from
Closed

Update README.md v5.25.0 #176

wants to merge 5 commits into from

Conversation

ericgaspar
Copy link
Member

Add some info to the README

@kemenaran
Copy link
Collaborator

Thanks. It does seem to improve the readme a little, but I'm curious: why so many changes? Is it following some template found elsewhere?

README.md Outdated

## Installing
**Shipped version:** 5.23.1
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure I want to state the Mattermost version number in the readme, as it makes one more place to update every time the version is bumped.

Instead we could state that this package follows the versions of Mattermost released monthly.

Copy link
Member Author

Choose a reason for hiding this comment

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

There is a model to follow for packaging applications (https://github.com/YunoHost/example_ynh). It is not mandatory but it helps to structure the different information and standardize the apps in the YunoHost catalog.
It is also worth the little extra work that the user of the application knows about the available version.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm all for the new README template ; thanks for the PR.

However I definitely would like to limit the number to places to update when a new version gets released.

How about something that says :

Shipped version: [see app.src](link to app.src) (follows monthly Mattermost releases)

?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's your choice, but why make things more difficult for people and not comply with what everyone else is doing. It takes literally 2 seconds to change the version number...

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes. But I'd like to keep the app as close to Mattermost released version as possible (including several releases and dot-releases a month), and that involves making the release process as automated and painless as possible. So I'd really like to prevent new steps to be added on each upgrade, because small things add up.

README.md Outdated Show resolved Hide resolved
@ericgaspar ericgaspar changed the title Update README.md Update README.md v5.24.1 Jun 21, 2020
@ericgaspar ericgaspar changed the title Update README.md v5.24.1 Update README.md v5.24.2 Jun 30, 2020
@ericgaspar ericgaspar changed the title Update README.md v5.24.2 Update README.md v5.25.0 Jul 16, 2020
@ericgaspar ericgaspar closed this Jul 18, 2020
@ericgaspar ericgaspar deleted the enh-README branch July 18, 2020 13:09
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

2 participants