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

MAINT: Travis-CI -> GitHub Actions in plugin docs #576

Merged
merged 1 commit into from
May 30, 2024
Merged

MAINT: Travis-CI -> GitHub Actions in plugin docs #576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions source/plugins/developing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ This manual refreshing of the ``q2cli`` cache is necessary because it can't dete
Plugin testing
--------------

Many of the QIIME 2 plugins, including `q2-emperor`_ and `q2-diversity`_, have continuous integration (CI) configuration for `Travis-CI`_ in their software repositories. This allows for automated testing any time a change to the plugin code is committed on GitHub if Travis-CI is enabled on the plugin's software repository. Plugin CI testing generally includes ``flake8`` linting/style-checking and a ``nose`` or ``py.test`` command for running unit tests.
Many of the QIIME 2 plugins, including `q2-emperor`_ and `q2-diversity`_, have continuous integration (CI) configuration for `GitHub Actions`_ in their software repositories. This allows for automated testing any time a change to the plugin code is committed on GitHub if GitHub Actions are enabled on the plugin's software repository. Plugin CI testing generally includes ``flake8`` linting/style-checking and a ``nose`` or ``py.test`` command for running unit tests.

Plugin developers are encouraged to add unit tests for their plugin's functionality, and to perform style checking with ``flake8``. Unit tests are an important part of determining if your software is working as expected, which will give you and your users confidence in the plugin. Adhering to a style convention, and checking that style with a tool like ``flake8``, is very helpful for others who want to understand your code, including users who want an in depth understanding of the functionality and potential open source software contributors.

Expand Down Expand Up @@ -251,7 +251,7 @@ Example plugins

.. _`q2-diversity`: https://github.com/qiime2/q2-diversity

.. _`Travis-CI`: https://travis-ci.org/
.. _`GitHub Actions`: https://docs.github.com/en/actions

.. _`mypy`: http://mypy-lang.org/

Expand Down
Loading