Skip to content

Commit

Permalink
chore: harmonize templates (#351)
Browse files Browse the repository at this point in the history
* chore: harmonize templates

* chore: fix reuse compliance
  • Loading branch information
lkstrp authored Jul 8, 2024
1 parent 6346a42 commit f694629
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 70 deletions.
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
#
# SPDX-License-Identifier: CC0-1.0
name: Bug Report
description: Create a report if something doesn't work quite right.
labels: ["type: bug"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Please do not post usage questions here. Ask them on the
[PyPSA mailing list](https://groups.google.com/forum/#!forum/pypsa).
- type: checkboxes
id: checks
attributes:
label: Version Checks (indicate both or one)
options:
- label: >
I have confirmed this bug exists on the lastest
[release](https://github.com/pypsa/atlite/releases) of Atlite.
- label: >
I have confirmed this bug exists on the current
[`master`](https://github.com/pypsa/atlite/tree/master) branch of Atlite.
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue.
validations:
required: true

- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
Please provide a minimal, copy-pastable example.
placeholder: >
import atlite
...
render: python

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
- type: textarea
id: version
attributes:
label: Installed Versions
description: >
Please share information on your environment. Paste the output below. For conda ``conda env export`` and for pip ``pip freeze``.
value: >
<details>
Replace this line.
</details>
4 changes: 4 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
#
# SPDX-License-Identifier: CC0-1.0

# dependabot
# Ref: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
# ------------------------------------------------------------------------------
Expand Down
36 changes: 7 additions & 29 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,13 @@ SPDX-License-Identifier: CC0-1.0

Closes # (if applicable).

## Change proposed in this Pull Request
## Changes proposed in this Pull Request

<!--- Provide a general, short summary of your changes in the title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Type of change
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I tested my contribution locally and it seems to work fine.
- [ ] I locally ran `pytest` inside the repository and no unexpected problems came up.
- [ ] I have adjusted the docstrings in the code appropriately.
- [ ] I have documented the effects of my code changes in the documentation `doc/`.
- [ ] I have added newly introduced dependencies to `environment.yaml` file.
- [ ] I have added a note to release notes `doc/release_notes.rst`.
- [ ] I have used `pre-commit run --all` to lint/format/check my contribution

- [ ] Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in `doc`.
- [ ] Unit tests for new features were added (if applicable).
- [ ] Newly introduced dependencies are added to `environment.yaml`, `environment_docs.yaml` and `setup.py` (if applicable).
- [ ] A note for the release notes `doc/release_notes.rst` of the upcoming release is included.
- [ ] I consent to the release of this PR's code under the MIT license.

0 comments on commit f694629

Please sign in to comment.