Merge branch 'main' into 979_cloudfeedback_xcdat

.github/DISCUSSION_TEMPLATE/2-questions.yml

@@ -0,0 +1,70 @@
+labels: [question]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for your interest in PMP! Please follow the template below to ensure the development team and community can help you effectively.
+
+ - type: checkboxes
+ id: checks
+ attributes:
+ label: Question criteria
+ description: Please confirm and check all the following options.
+ options:
+ - label: I added a descriptive title here.
+ required: true
+ - label: I searched the [PMP GitHub Discussions](https://github.com/PCMDI/pcmdi_metrics/discussions) to find a similar question and didn't find it.
+ required: true
+ - label: I searched the [PMP documentation](http:https://pcmdi.github.io/pcmdi_metrics/).
+ required: true
+
+ - type: textarea
+ id: your-question
+ attributes:
+ label: Describe your question
+ description: |
+ Please help the community help you. The more specific you can be, the easier it will be to help.
+ validations:
+ required: true
+
+ - type: textarea
+ id: possible-answers
+ attributes:
+ label: Are there are any possible answers you came across?
+ description: |
+ This will help others determine if you're on the right track. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
+
+ - type: textarea
+ id: sample-code
+ attributes:
+ label: Minimal Complete Verifiable Example (MVCE)
+ description: |
+ Minimal, self-contained copy-pastable example that generates the question/issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
+ Examples that follow these guidelines are easier to parse. This section will be automatically formatted into code, so no need for markdown backticks.
+
+ See guidelines below on how to provide a good MCVE:
+
+ - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
+ - [Craft Minimal Bug Reports](http:https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+ render: python
+
+ - type: textarea
+ id: log-output
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
+ render: python
+
+ - type: textarea
+ id: show-versions
+ attributes:
+ label: Environment
+ description: |
+ If an MVCE and log output was provided, share your PMP version and some other information if your environment here
+
+ - type: textarea
+ id: extra
+ attributes:
+ label: Anything else we need to know?
+ description: |
+ Please describe any other information you want to share.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug Report
+description: File a bug report to help us improve PMP
+title: "[Bug]: "
+labels: ["Type: Bug"]
+assignees: []
+body:
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: |
+ Thanks for reporting a bug! Please describe what you were trying to get done.
+ Tell us what happened, what went wrong.
+ validations:
+ required: true
+
+ - type: textarea
+ id: what-did-you-expect-to-happen
+ attributes:
+ label: What did you expect to happen? Are there are possible answers you came across?
+ description: |
+ Describe what you expected to happen. Include links to pages you've researched (e.g., software docs, Stack Overflow posts).
+ validations:
+ required: false
+
+ - type: textarea
+ id: sample-code
+ attributes:
+ label: Minimal Complete Verifiable Example (MVCE)
+ description: |
+ Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted (e.g., module imports, publicly accessible files).
+ Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. This section will be automatically formatted into code, so no need for markdown backticks.
+
+ See guidelines below on how to provide a good MCVE:
+
+ - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
+ - [Craft Minimal Bug Reports](http:https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+ render: python
+
+ - type: textarea
+ id: log-output
+ attributes:
+ label: Relevant log output
+ description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
+ render: python
+
+ - type: textarea
+ id: extra
+ attributes:
+ label: Anything else we need to know?
+ description: |
+ Please describe any other information you want to share.
+
+ - type: textarea
+ id: show-versions
+ attributes:
+ label: Environment
+ description: |
+ Please share some information about your environment.
+ validations:
+ required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Questions (PMP)
+ url: https://github.com/PCMDI/pcmdi_metrics/discussions
+ about: |
+ Ask questions and discuss with other PMP community members here. Please
+ browse the PMP Discussions Forum or PMP documentation first before asking a
+ question to make sure it is not already answered. If you can't find an
+ answer, please include a self-contained reproducible example with your
+ question if possible. Thanks!
+

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,15 @@
+name: Documentation Update
+description: Update PMP documentation
+title: "[Doc]: "
+labels: ["Type: Documentation"]
+assignees: []
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Describe your documentation update
+ description: |
+ Concise description of why the documentation is being updated (e.g., missing content for new feature, typo)
+ If this is related to an issue or PR, please mention it.
+ validations:
+ required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature Request
+description: Suggest an idea for PMP
+title: "[Feature]: "
+labels: ["Type: Enhancement"]
+assignees: []
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Is your feature request related to a problem?
+ description: |
+ Please do a quick search of existing issues to make sure that this has not been asked before.
+ Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: Describe the solution you'd like
+ description: |
+ A clear and concise description of what you want to happen.
+ validations:
+ required: false
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Describe alternatives you've considered
+ description: |
+ A clear and concise description of any alternative solutions or features you've considered.
+ validations:
+ required: false
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional context
+ description: |
+ Add any other context about the feature request here.
+ validations:
+ required: false

.vscode/pcmdi_metrics.code-workspace

@@ -0,0 +1,53 @@
+// This file stores the pcmdi_metrics repository's VS Code workspace settings.
+// Simply open up this file in VS Code and the editor will be automatically configured using this file.
+// Workspace settings take precedence over your user settings.
+{
+ "folders": [
+ {
+ "path": ".."
+ }
+ ],
+ "settings": {
+ // ===================
+ // Editor settings
+ // ===================
+ "editor.formatOnSave": true,
+ // ===================
+ // Python settings
+ // ===================
+ "[python]": {
+ // editor.rulers: [comments, max line length, wrap line length],
+ // Black does not wrap comments.
+ "editor.rulers": [80, 88, 120],
+ "editor.wordWrap": "wordWrapColumn",
+ "editor.wordWrapColumn": 120,
+ "editor.defaultFormatter": "ms-python.black-formatter"
+ },
+ "black-formatter.importStrategy": "fromEnvironment",
+ // Code Formatting and Linting
+ // ---------------------------
+ "flake8.args": ["--config=setup.cfg"],
+ "flake8.importStrategy": "fromEnvironment",
+ // Type checking
+ // ---------------------------
+ "mypy-type-checker.args": ["--config=pyproject.toml"],
+ "mypy-type-checker.importStrategy": "fromEnvironment",
+ // Testing
+ // ---------------------------
+ "python.testing.unittestEnabled": false,
+ "python.testing.pytestEnabled": true,
+ // NOTE: Debugger doesn't work if pytest-cov is enabled, so set "--no-cov"
+ // https://github.com/microsoft/vscode-python/issues/693
+ "python.testing.pytestArgs": ["--no-cov"],
+ // ===================
+ // Extension settings
+ // ===================
+ "jupyter.notebookFileRoot": "${workspaceFolder}",
+ "autoDocstring.docstringFormat": "numpy",
+ "[restructuredtext]": {
+ "editor.rulers": [88, 120],
+ "editor.wordWrap": "wordWrapColumn",
+ "editor.wordWrapColumn": 120
+ }
+ }
+}