From 6fa3d02a754cda086fd05baab59ff41bd09a8055 Mon Sep 17 00:00:00 2001 From: Ian Kenney Date: Fri, 17 Nov 2023 17:14:34 -0700 Subject: [PATCH] Added a note on src_install --- docs/source/makingakit.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/source/makingakit.rst b/docs/source/makingakit.rst index 436f55a5..675c4957 100644 --- a/docs/source/makingakit.rst +++ b/docs/source/makingakit.rst @@ -564,13 +564,15 @@ One of the more pressing requirements for kit registration is clearly identifyin This is typically included in a LICENSE file at the top level of your repository. `Without a license `_, the only assumption a user can make about your code is that they are not in a position to use your code. Your license needs to be compatible with the GPLv2+ license currently used by MDAnalysis. -Take time to consider how you would like to license your project. +Take time to consider how you would like to `license your project `_. Hosting code in a version controlled repository *********************************************** Since the MDAKits registry makes heavy use of the GitHub actions infrastructure, registration of a kit requires that all code maintainers also have a GitHub account for communication purposes. For this reason, if your code is not already hosted in an accessible version controlled repository, hosting on `GitHub `_ is recommended, although other services such as `Bitbucket `_, `GitLab `_, or self hosting is possible. +With publicly accessible code, users are not required to get go through intermediate packaging services such as the Python Package Index or conda-forge, although having your code available through these services is highly encouraged. +After registration, users can find the installation instructions for the source code on your MDAKit page, which is specified in the ``src_install`` field in the ``metadata.yaml`` file (see :ref:`specification`). Documentation ************* @@ -589,9 +591,10 @@ We also require that minimal regression tests are present. These tests are not just useful for when you make changes to your code, but also when using your code with newer versions of MDAnalysis/Python. These tests are to signify to the users of your packages that the code performs at least the way you say it should and give them confidence that it can be used. Basic tests can be written with a variety of packages, such as the `unittest package `_ or the `pytest package `_. -Further improvements to your testing procedure may include automatically running the tests on pushing to your remote repositories (see `GitHub Actions `_). +Further improvements to your testing procedure may include automatically running the tests on pushing to your remote repositories, often referred to as continuous integration (CI). +CI can be set up using repository pipeline tools, such as `GitHub Actions `_. -When submitting an MDAKit to the registry, you can include the instructions for running the tests in the required ``metadata.yaml`` file (see a full example in the `registration `_ section below). +When submitting an MDAKit to the registry, include the instructions for running the tests in the required ``metadata.yaml`` file (see a full example in the `registration `_ section below). Assuming that your tests are in a ``test/`` directory at the top level of your repository, you could define your test commands as: .. code-block:: yaml