Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update project structure and configuration #20

Merged
merged 7 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
282 changes: 141 additions & 141 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,146 +4,146 @@ description: Create a report to help us improve
labels: ["bug", "needs-triage"]

body:
- type: markdown
attributes:
value: >
**Thank you for wanting to report a bug in Envers!**


Verify first that your issue is not [already reported on
GitHub][issue search].


[issue search]: https://github.com/Envers/Envers/issues?q=is%3Aopen+is%3Aissue+label%3Abug

- type: textarea
attributes:
label: Summary
description: Explain the problem briefly below.
placeholder: >-
When I try to do X with {{ cookiecutter.project_name }} and the following workspace, Y breaks or
Z happens in an unexpected manner.
Here are all the details I know about this problem.
validations:
required: true

- type: textarea
attributes:
label: OS / Environment
description: >-
Provide information on your operating system.
Something like the output of `cat /etc/os-release` on Linux or
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
render: console
placeholder: |
# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal

# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:

System Software Overview:

System Version: macOS 10.15.7 (19H1323)
Kernel Version: Darwin 19.6.0
validations:
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: >-
Describe exactly how to reproduce the problem, using a minimal test-case.
It would *really* help us understand your problem if you paste in the Python code
that you're running.


**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Paste your minimal failing Python example code between the quotes below -->
```python (paste below)

```

<!--- ...or if you have a failing CLI command paste it between the quotes below -->
```console (paste below)

```
validations:
required: true

- type: textarea
attributes:
label: File Upload (optional)
description: >-
If your steps to reproduce your minimal failing example require either a spec or a
workspace file, please upload it by attaching it to the text area here.


**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
placeholder: >-
Attach any files or compressed archives by dragging & dropping, selecting,
or pasting them here.
validations:
required: false

- type: textarea
attributes:
label: Expected Results
description: >-
Describe what you expected to happen when running the steps above.
placeholder: >-
I expected X to happen because I assumed Y.
validations:
required: true

- type: textarea
attributes:
label: Actual Results
description: >-
Paste verbatim program or command output.
Don't wrap it with triple backticks &mdash; your whole input will be
turned into a code snippet automatically.
render: console
validations:
required: true

- type: textarea
attributes:
# label: Envers version
# description: >-
# Paste verbatim output from `Envers --version` below, under the prompt line.
# Don't wrap it with triple backticks &mdash; your whole input will be
# turned into a code snippet automatically.
render: console
placeholder: |
python -m pip show Envers
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`Envers` Code of Conduct][CoC] first.

[CoC]: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
- type: markdown
attributes:
value: >
**Thank you for wanting to report a bug in Envers!**


Verify first that your issue is not [already reported on
GitHub][issue search].


[issue search]: https://github.com/Envers/Envers/issues?q=is%3Aopen+is%3Aissue+label%3Abug

- type: textarea
attributes:
label: Summary
description: Explain the problem briefly below.
placeholder: >-
When I try to do X with {{ cookiecutter.project_name }} and the following workspace, Y breaks or
Z happens in an unexpected manner.
Here are all the details I know about this problem.
validations:
required: true

- type: textarea
attributes:
label: OS / Environment
description: >-
Provide information on your operating system.
Something like the output of `cat /etc/os-release` on Linux or
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
render: console
placeholder: |
# Linux
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.04.2 LTS"
VERSION_ID="20.04"
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
VERSION_CODENAME=focal
UBUNTU_CODENAME=focal

# macOS
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
Software:

System Software Overview:

System Version: macOS 10.15.7 (19H1323)
Kernel Version: Darwin 19.6.0
validations:
required: true
...

- type: textarea
attributes:
label: Steps to Reproduce
description: >-
Describe exactly how to reproduce the problem, using a minimal test-case.
It would *really* help us understand your problem if you paste in the Python code
that you're running.


**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
value: |
<!--- Paste your minimal failing Python example code between the quotes below -->
```python (paste below)

```

<!--- ...or if you have a failing CLI command paste it between the quotes below -->
```console (paste below)

```
validations:
required: true

- type: textarea
attributes:
label: File Upload (optional)
description: >-
If your steps to reproduce your minimal failing example require either a spec or a
workspace file, please upload it by attaching it to the text area here.


**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
placeholder: >-
Attach any files or compressed archives by dragging & dropping, selecting,
or pasting them here.
validations:
required: false

- type: textarea
attributes:
label: Expected Results
description: >-
Describe what you expected to happen when running the steps above.
placeholder: >-
I expected X to happen because I assumed Y.
validations:
required: true

- type: textarea
attributes:
label: Actual Results
description: >-
Paste verbatim program or command output.
Don't wrap it with triple backticks &mdash; your whole input will be
turned into a code snippet automatically.
render: console
validations:
required: true

- type: textarea
attributes:
# label: Envers version
# description: >-
# Paste verbatim output from `Envers --version` below, under the prompt line.
# Don't wrap it with triple backticks &mdash; your whole input will be
# turned into a code snippet automatically.
render: console
placeholder: |
python -m pip show Envers
validations:
required: true

- type: checkboxes
attributes:
label: Code of Conduct
description: |
Read the [`Envers` Code of Conduct][CoC] first.

[CoC]: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
options:
- label: I agree to follow the Code of Conduct
required: true
---
This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.
24 changes: 12 additions & 12 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: 🙋 Usage Questions
url: https://github.com/Envers/Envers/discussions
about: |
Use Envers's GitHub Discussions to ask "How do I do X with Cookiecutter?".
- name: 📖 Tutorial
url: https://github.com/Envers/Envers
about: |
The Envers tutorial is continually updated and provides an in depth walkthrough
of how to use the latest release of Cookiecutter.
- name: 📝 Envers Code of Conduct
url: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
about: Expectations for how people will interact with each other on Cookiecutter's GitHub.
- name: 🙋 Usage Questions
url: https://github.com/Envers/Envers/discussions
about: |
Use Envers's GitHub Discussions to ask "How do I do X with Cookiecutter?".
- name: 📖 Tutorial
url: https://github.com/Envers/Envers
about: |
The Envers tutorial is continually updated and provides an in depth walkthrough
of how to use the latest release of Cookiecutter.
- name: 📝 Envers Code of Conduct
url: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
about: Expectations for how people will interact with each other on Cookiecutter's GitHub.
Loading
Loading