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.

Sign up for GitHub

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

Jump to bottom

extend plugin design guidelines #3799

Merged
merged 5 commits into from
Mar 22, 2020
Merged

extend plugin design guidelines #3799

merged 5 commits into from
Mar 22, 2020

Conversation

ltalirz
Copy link
Member

@ltalirz ltalirz commented Feb 24, 2020 •
edited by sphuber
Loading

Fixes #3461

  • update plugin design guidelines with suggestions on how to think about which information to store where.
  • fix naming convention of "plugin" vs "plugin package" across the whole aiida-core documentation (+ some further cleanup of the plugin docs)

@ltalirz ltalirz force-pushed the update-plugin-guidelines branch 2 times, most recently from ed4c06e to f623d1d Compare February 24, 2020 15:53
@ltalirz ltalirz requested review from sphuber and ramirezfranciscof and removed request for sphuber February 24, 2020 16:15
@ltalirz
Copy link
Member Author

ltalirz commented Feb 27, 2020

@ramirezfranciscof that should be a pretty easy review

@ltalirz ltalirz closed this Mar 10, 2020
@ltalirz ltalirz reopened this Mar 10, 2020
@codecov
Copy link

codecov bot commented Mar 10, 2020 •
edited
Loading

Codecov Report

Merging #3799 into develop will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #3799   +/-   ##
========================================
  Coverage    77.16%   77.16%           
========================================
  Files          458      458           
  Lines        33774    33774           
========================================
  Hits         26062    26062           
  Misses        7712     7712
Flag Coverage Δ
#django 69.20% <ø> (ø)
#sqlalchemy 70.02% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b90a629...adc92bd. Read the comment docs.

@ltalirz
Copy link
Member Author

ltalirz commented Mar 20, 2020

@ramirezfranciscof Do you prefer if I let someone else review this PR?

ltalirz added 2 commits March 20, 2020 21:33
@ltalirz
extend plugin design guidelines
7c71803 
update plugin design guidelines with suggestions on how to think about which information to store where.
@ltalirz
apply plugin (package) naming convention
ab545c8 
Apply naming convention for AiiDA plugins (=extensions of aiida-core)
and AiiDA plugin packages (=bundles of plugins, for distribution).
Also update several sections related to migration from older AiiDA
versions & plugin development in general.
@ltalirz ltalirz force-pushed the update-plugin-guidelines branch from f623d1d to ab545c8 Compare March 20, 2020 22:35
@ltalirz ltalirz requested a review from sphuber March 20, 2020 22:37
sphuber
sphuber requested changes Mar 21, 2020
View reviewed changes
Copy link
Contributor

@sphuber sphuber left a comment

Choose a reason for hiding this comment

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

Thanks @ltalirz , just a few minor comments

docs/source/get_started/index.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/basics.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/basics.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/entry_points.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/publish.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/publish.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/publish.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/publish.rst Outdated Show resolved Hide resolved
@ltalirz ltalirz force-pushed the update-plugin-guidelines branch from c2d18fe to 6ce67f6 Compare March 22, 2020 16:59
@ltalirz ltalirz requested a review from sphuber March 22, 2020 17:03
@ltalirz
Copy link
Member Author

ltalirz commented Mar 22, 2020 •
edited
Loading

Thanks for the review!
To make things easier to review I've added all suggestions in one additional commit (not squashed).

sphuber
sphuber requested changes Mar 22, 2020
View reviewed changes
Copy link
Contributor

@sphuber sphuber left a comment

Choose a reason for hiding this comment

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

Thanks a lot @ltalirz . Looking very good, just two minor things that I just spotted. After that it is good to merge

docs/source/developer_guide/plugins/basics.rst Outdated Show resolved Hide resolved
docs/source/developer_guide/plugins/basics.rst Outdated Show resolved Hide resolved
@ltalirz @sphuber
Apply suggestions from code review
adc92bd 
Co-Authored-By: Sebastiaan Huber <mail@sphuber.net>
@ltalirz
Copy link
Member Author

ltalirz commented Mar 22, 2020

Done!

@sphuber sphuber merged commit 9ce2183 into aiidateam:develop Mar 22, 2020
@sphuber
Copy link
Contributor

sphuber commented Mar 22, 2020

Thanks @ltalirz !

@sphuber sphuber deleted the update-plugin-guidelines branch March 22, 2020 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sphuber sphuber sphuber approved these changes

@ramirezfranciscof ramirezfranciscof Awaiting requested review from ramirezfranciscof

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

clarifying the meaning of "plugin", "package" etc.
2 participants
@ltalirz @sphuber