Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Minor fixes release notes #3641

Merged
merged 7 commits into from
Jan 31, 2021
Merged

Minor fixes release notes #3641

merged 7 commits into from
Jan 31, 2021

Conversation

markus2330
Copy link
Contributor

Basics

These points need to be fulfilled for every PR:

  • Short descriptions of your changes are in the release notes
    (added as entry in doc/news/_preparation_next_release.md which
    contains _(my name)_)
    Please always add something to the release notes.
  • Details of what you changed are in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, are in the commit messages.
  • The buildservers are happy. If not, fix in this order:
    • add a line in doc/news/_preparation_next_release.md
    • reformat the code with scripts/dev/reformat-all
    • make all unit tests pass
    • fix all memleaks
  • The PR is rebased with current master.

If you have any troubles fulfilling these criteria, please write
about the trouble as comment in the PR. We will help you.
But we cannot accept PRs that do not fulfill the basics.

Checklist

Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar none of these points below
need to be checked.

  • I added unit tests for my code
  • I fully described what my PR does in the documentation
    (not in the PR description)
  • I fixed all affected documentation
  • I added code comments, logging, and assertions as appropriate (see Coding Guidelines)
  • I updated all meta data (e.g. README.md of plugins and METADATA.ini)
  • I mentioned every code not directly written by me in THIRD-PARTY-LICENSES

Review

Reviewers will usually check the following:

Labels

If you are already Elektra developer:

  • Add the "work in progress" label if you do not want the PR to be reviewed yet.
  • Add the "ready to merge" label if the basics are fulfilled and you also
    say that everything is ready to be merged.

@markus2330 markus2330 requested a review from mpranj January 30, 2021 16:21
@markus2330 markus2330 added this to the 0.9.4 milestone Jan 30, 2021
@markus2330
Copy link
Contributor Author

I read through the release notes again with how the website gets rendered and fixed several more things. Otherwise this PR is like #3638, which can be closed after this is merged.

This will most probably be the last commits from me today.

@markus2330 markus2330 mentioned this pull request Jan 30, 2021
7 tasks
@@ -157,7 +159,7 @@ The 0.9.\* series of Elektra is for development of Elektra 1.0.
Elektra 1.0 will be incompatible to 0.8 and as such, we need a SO version bump.
Copy link
Member

Choose a reason for hiding this comment

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

This comment actually refers to line 146:
Is there a reason why the the RPM instruction are in the DEB instructions block? They both also begin with 2..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tried to shorten it even more but I agree it might be a bit confusing. Note that it actually renders 2x "2.", so it is somewhat clear that only one of the second steps should be done. But please feel free to improve, simply push to this branch.

Copy link
Member

Choose a reason for hiding this comment

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

I changed the installation guide a bit, I'm not sure if the additional headers are the right way, but it looks IMO a bit more structured. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I actually misunderstood which text belongs to DEB and what to RPM. Thank you for fixing it!

@mpranj mpranj merged commit b44ec9d into master Jan 31, 2021
@mpranj
Copy link
Member

mpranj commented Jan 31, 2021

Thank you both so much!

@markus2330 markus2330 deleted the minor_fixes_release_notes branch January 31, 2021 13:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants