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

Minor documentation updates #2942

Merged
merged 4 commits into from
Sep 9, 2019

Conversation

kodebach
Copy link
Member

@kodebach kodebach commented Sep 8, 2019

More update from the review of #2927.

Basics

  • Short descriptions should be in the release notes (added as entry in
    doc/news/_preparation_next_release.md which contains _(my name)_)
    Please always add something to the the release notes.
  • Longer descriptions should be in documentation or in design decisions.
  • Describe details of how you changed the code in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, should be in the commit messages.

Checklist

  • I added unit tests for my code
  • 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:

Co-Authored-By: René Schwaiger <sanssecours@me.com>
@markus2330
Copy link
Contributor

Thank you for creating this PR!

@markus2330 markus2330 merged commit 8bef05c into ElektraInitiative:master Sep 9, 2019
@kodebach kodebach deleted the codegen_doc branch September 9, 2019 16:17
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