Some GitHub requirement clarifications (#85)

* Some GitHub requirement clarifications * Update add.rst * Update metadata.yaml
MDAnalysis · Oct 1, 2023 · a7cf218 · a7cf218
1 parent c9d672f
commit a7cf218
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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