From a7cf218bcc42895eab2ca89c673c9317d54b7d72 Mon Sep 17 00:00:00 2001 From: Irfan Alibay Date: Sun, 1 Oct 2023 09:45:17 +0100 Subject: [PATCH] Some GitHub requirement clarifications (#85) * Some GitHub requirement clarifications * Update add.rst * Update metadata.yaml --- docs/source/add.rst | 3 +++ mdakits/template/metadata.yaml | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/source/add.rst b/docs/source/add.rst index 27c6702f..b4a14924 100644 --- a/docs/source/add.rst +++ b/docs/source/add.rst @@ -156,6 +156,8 @@ entries**. - https://github.com/GH_HOST_ACCOUNT/MYPROJECT/blob/main/AUTHORS ## List(str): a list of maintainers + ## Please note these _must_ be GitHub handles + ## The maintainers will be tagged in issues if their MDAKit is failing. maintainers: - NAME1 - OPTIONAL_NAME2 @@ -175,6 +177,7 @@ entries**. license: GPL-2.0-or-later ## str: the link to the project's code + ## Please note that this is not limited to GitHub! Can be Gitlab, etc.. project_home: https://github.com/GH_HOST_ACCOUNT/MYPROJECT/ ## str: the link to the project's documentation diff --git a/mdakits/template/metadata.yaml b/mdakits/template/metadata.yaml index 778ba64c..105d9ecb 100644 --- a/mdakits/template/metadata.yaml +++ b/mdakits/template/metadata.yaml @@ -22,6 +22,8 @@ authors: - https://github.com/GH_HOST_ACCOUNT/MYPROJECT/blob/main/AUTHORS ## List(str): a list of maintainers +## Please note these _must_ be GitHub handles +## The maintainers will be tagged in issues if their MDAKit is failing. maintainers: - NAME1 - OPTIONAL_NAME2 @@ -41,6 +43,7 @@ keywords: license: GPL-2.0-or-later ## str: the link to the project's code +## Please note that this is not limited to GitHub! Can be Gitlab, etc.. project_home: https://github.com/GH_HOST_ACCOUNT/MYPROJECT/ ## str: the link to the project's documentation