MAINT: update standard docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +1,29 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
+about: Create a report to report a problem that needs to be fixed
+labels: bug
+title: "BUG: "
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+# Description
+A clear and concise description of what the bug is, including a description
+of what you expected the outcome to be.
 
-**To Reproduce**
+# To Reproduce this bug:
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+Consider including images or test files to help others reproduce the bug and
+solve the problem.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
+## Test configuration
+ - OS: [e.g., Hal]
+ - Version [e.g., Python 3.47]
  - Other details about your setup that could be relevant
 
-**Additional context**
-Add any other context about the problem here.
+# Additional context
+Add any other context about the problem here, including expected behaviour.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,27 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
+title: "ENH: "
+labels: enhancement
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+# Description
+A clear and concise description of the new feature or behaviour you would like.
 
-**Describe the solution you'd like**
+## Potential impact
+
+- Is the feature related to an existing problem?
+- How critical is this feature to your workflow?
+- How wide of an impact to you anticipate this enhancement having?
+- Would this break any existing functionality?
+
+## Potential solution(s)
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+# Alternatives
+A clear description of any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+# Additional context
+Add any other context or screenshots about the feature request here, potentially
+including your operational configuration.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,19 @@
+---
+name: Question
+about: A question about this project
+title: "QUEST: "
+labels: question
+
+---
+
+# Description
+A clear and concise summary of your query
+
+## Example code (optional)
+If relevant, include sample code, images, or files so that others can understand
+the full context of your question.
+
+## Configuration
+ - OS: [e.g., Hal]
+ - Version: [e.g., Python 3.47]
+ - Other details about your setup that could be relevant

.github/workflows/docs.yml

@@ -1,5 +1,6 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+# This workflow will install Python dependencies, run tests and lint
+# with a variety of Python versions. For more information see:
+# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Documentation Check
 
@@ -8,7 +9,7 @@ on: [push, pull_request]
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ["ubuntu-latest"]
     strategy:
       fail-fast: false
       matrix:

.github/workflows/main.yml

@@ -10,11 +10,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.11", "3.12"]
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.11", "3.12"]
         numpy_ver: ["latest"]
         test_config: ["latest"]
         include:
+           # NEP29 compliance settings
            - python-version: "3.10"
              numpy_ver: "1.24"
              os: "ubuntu-latest"
@@ -37,8 +38,7 @@ jobs:
 
     - name: Install standard dependencies
       if: ${{ matrix.test_config == 'latest'}}
-      run: |
-        pip install .[test]
+      run: pip install .[test]
 
     - name: Set up pysat
       run: |

.github/workflows/pysat_rc.yml

@@ -11,7 +11,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.11"]
+        python-version: ["3.12"]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}

ACKNOWLEDGEMENTS.md

@@ -0,0 +1,30 @@
+Funding
+=======
+The following institutions, missions, and programs have provided funding
+for pysat development.
+
+Institutions
+------------
+ - The Catholic University of America (CUA)
+ - Cosmic Studio
+ - Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office
+ - National Aeronautics and Space Administration (NASA)
+ - National Oceanic and Atmospheric Administration (NOAA)
+ - National Science Foundation (NSF)
+
+Missions
+--------
+ - NOAA Constellation Observing System for Meteorology Ionosphere and Climate (COSMIC-2)
+ - NASA Ionospheric Connections Explorer (ICON)
+ - NASA Scintillation Observations and Response of the Ionosphere to Electrodynamics (SORTIE)
+ - NASA Scintillation Prediction Observations Research Task (SPORT)
+
+Programs
+--------
+ - NSF 125908, AGS-1651393
+ - NASA NNX10AT02G, NNH20ZDA001N-LWS, 80NSSC18K120, and 80NSSC21M0180
+ - NASA Space Precipitation Impacts (SPI) project at Goddard Space Flight Center through the Heliophysics Internal Science Funding Model.
+
+Disclaimers
+===========
+Any opinions or actions taken by the listed funding institutions are those of the institutions and do not necessarily reflect the views of the pysat development team or individual authors. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the funding agencies.

CHANGELOG.md

@@ -11,6 +11,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   - Dropped tests for deprecated pysat instruments
   - Implement pyproject.toml
   - Implement coveralls app for GitHub Actions
+  - Update contributing document and issue templates
+  - Add Acknowledgements doc
 
 ## [0.2.0] - 2022-08-12
 - New Features