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

Improve affiliated package page structure #417

Merged
merged 3 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions affiliated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Affiliated Packages
Affiliated packages are well-maintained, open source software packages that are useful to solar physicists and integrate well with the SunPy ecosystem.
To aid discoverability, all affiliated packages are listed on the SunPy website, and the SunPy project tries to advertise them at national and international conferences and workshops.

Package list
------------
Current packages
----------------

.. list-table::
:widths: 20, 80
Expand Down Expand Up @@ -414,14 +414,11 @@ Review Criteria and Summary
| | provisional rating. |
+---------------+-----------------------------------------------------+

Open review process
^^^^^^^^^^^^^^^^^^^
Becoming an affiliated package
------------------------------

The review process for becoming a SunPy affiliated package is designed to be approachable, lightweight and open.
Reviews are conducted in GitHub issues through the https://github.com/sunpy/sunpy.org repository.

Steps for Getting New Packages Reviewed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The review process for becoming an affiliated package is designed to be approachable, lightweight and open.
Reviews are conducted in GitHub issues through the https://github.com/sunpy/sunpy.org repository, using the following process:

1. If you're not sure whether to submit your package for the affiliated package review process, you can open an issue to informally discuss your package or contact the :ref:`role_affiliated-liaison` to discuss your package privately.
2. Open a new issue with the issue template.
Expand All @@ -434,7 +431,7 @@ Steps for Getting New Packages Reviewed
9. The :ref:`role_affiliated-liaison` merges the pull request.

Existing Packages Review Process
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Existing affiliated packages will be reviewed once per year by the :ref:`role_affiliated-liaison` to ensure the review is current.
Developers may challenge a new review, which then requires the liaison to get an independent reviewer to perform the review.
Expand All @@ -443,7 +440,7 @@ Existing provisional affiliated packages will be reviewed once per year by the :
To pass they must not have a worse score and still be working towards meeting the rest of the review criteria.

Acknowledgements
~~~~~~~~~~~~~~~~
----------------

Sections of this page are heavily inspired by the `Astropy affiliated package review process <https://github.com/astropy/project/blob/master/affiliated/affiliated_package_review_guidelines.md>`__.

Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sphinxext-opengraph
sunpy-sphinx-theme>=2.0.0

# Eclipse notebook
astropy
astropy<6.1
exifread
ipywidgets
matplotlib
Expand Down