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

simplify infos/status #3590

Closed
wants to merge 1 commit into from
Closed

simplify infos/status #3590

wants to merge 1 commit into from

Conversation

markus2330
Copy link
Contributor

fixes #666
fixes #3504

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
Copy link
Contributor Author

@kodebach @mpranj @sanssecours as promised I created a PR for further discussion how to improve&simplify the plugin's contract. Please feel free to comment anything or also to push commits to this branch.

@robaerd do you see value that we add the dependencies also to the contract? Then it would be available within CMake which dependencies which plugin needs. This information could then be added to the packages #3583.

@robaerd
Copy link
Member

robaerd commented Dec 13, 2020

All plugins only have language core deps which are discovered automatically during packaging. Only the python binding and the elektra-bin-extra package have external dependencies.

@markus2330
Copy link
Contributor Author

All plugins only have language core deps which are discovered automatically during packaging. Only the python binding and the elektra-bin-extra package have external dependencies.

Ok, then we can probably forget about this. So it would be only about the list of dependencies in the Dockerfiles. But the Dockerfiles themselves are actually quite a good documentation, so probably it is better to not move the package names into the README.md but instead link to Dockerfiles more prominently to show which deps Elektra has.

@stale
Copy link

stale bot commented Oct 14, 2022

I mark this stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping by writing a message here or create a new issue/PR with the remainder of this issue/PR.
Thank you for your contributions 💖

@stale stale bot added the stale label Oct 14, 2022
@stale
Copy link

stale bot commented Oct 29, 2022

I closed this now because it has been inactive for more than one year. If I closed it by mistake, please do not hesitate to reopen it or create a new issue/PR with the remainder of this issue/PR.
Thank you for your contributions 💖

@stale stale bot closed this Oct 29, 2022
@Janldeboer Janldeboer mentioned this pull request Dec 7, 2022
23 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Classification of storage plugins finalize infos/status
2 participants