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

Minor documentation updates #2942

Merged
merged 4 commits into from Sep 9, 2019

Conversation

@kodebach
Copy link
Contributor

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:

Update cmake/ElektraConfig.cmake.in
Co-Authored-By: René Schwaiger <sanssecours@me.com>
@markus2330

This comment has been minimized.

Copy link
Contributor

commented Sep 8, 2019

Thank you for creating this PR!

@markus2330 markus2330 merged commit 8bef05c into ElektraInitiative:master Sep 9, 2019

10 of 13 checks passed

LGTM analysis: C/C++ No code changes detected
Details
LGTM analysis: JavaScript No code changes detected
Details
LGTM analysis: Python No code changes detected
Details
continuous-integration/jenkins/pr-merge This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
restyled No differences
Details
🍎 Clang Task Summary
Details
🍎 Clang ASAN Task Summary
Details
🍎 FULL Task Summary
Details
🍎 MMap Task Summary
Details
🔗 Check Task Summary
Details
😈 FreeBSD 11 Task Summary
Details
😈 FreeBSD 12 Task Summary
Details

@kodebach kodebach deleted the kodebach:codegen_doc branch Sep 9, 2019

@kodebach kodebach referenced this pull request Sep 9, 2019
9 of 14 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.