Skip to content

Commit 2a85543

Browse files
authored
fix: Update project structure and configuration (#20)
1 parent ed7d75f commit 2a85543

31 files changed

+2127
-1610
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 141 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -4,146 +4,146 @@ description: Create a report to help us improve
44
labels: ["bug", "needs-triage"]
55

66
body:
7-
- type: markdown
8-
attributes:
9-
value: >
10-
**Thank you for wanting to report a bug in Envers!**
11-
12-
13-
14-
Verify first that your issue is not [already reported on
15-
GitHub][issue search].
16-
17-
18-
[issue search]: https://github.com/Envers/Envers/issues?q=is%3Aopen+is%3Aissue+label%3Abug
19-
20-
- type: textarea
21-
attributes:
22-
label: Summary
23-
description: Explain the problem briefly below.
24-
placeholder: >-
25-
When I try to do X with {{ cookiecutter.project_name }} and the following workspace, Y breaks or
26-
Z happens in an unexpected manner.
27-
Here are all the details I know about this problem.
28-
validations:
29-
required: true
30-
31-
- type: textarea
32-
attributes:
33-
label: OS / Environment
34-
description: >-
35-
Provide information on your operating system.
36-
Something like the output of `cat /etc/os-release` on Linux or
37-
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
38-
render: console
39-
placeholder: |
40-
# Linux
41-
$ cat /etc/os-release
42-
NAME="Ubuntu"
43-
VERSION="20.04.2 LTS (Focal Fossa)"
44-
ID=ubuntu
45-
ID_LIKE=debian
46-
PRETTY_NAME="Ubuntu 20.04.2 LTS"
47-
VERSION_ID="20.04"
48-
HOME_URL="https://www.ubuntu.com/"
49-
SUPPORT_URL="https://help.ubuntu.com/"
50-
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
51-
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
52-
VERSION_CODENAME=focal
53-
UBUNTU_CODENAME=focal
54-
55-
# macOS
56-
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
57-
Software:
58-
59-
System Software Overview:
60-
61-
System Version: macOS 10.15.7 (19H1323)
62-
Kernel Version: Darwin 19.6.0
63-
validations:
64-
required: true
65-
66-
- type: textarea
67-
attributes:
68-
label: Steps to Reproduce
69-
description: >-
70-
Describe exactly how to reproduce the problem, using a minimal test-case.
71-
It would *really* help us understand your problem if you paste in the Python code
72-
that you're running.
73-
74-
75-
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
76-
value: |
77-
<!--- Paste your minimal failing Python example code between the quotes below -->
78-
```python (paste below)
79-
80-
```
81-
82-
<!--- ...or if you have a failing CLI command paste it between the quotes below -->
83-
```console (paste below)
84-
85-
```
86-
validations:
87-
required: true
88-
89-
- type: textarea
90-
attributes:
91-
label: File Upload (optional)
92-
description: >-
93-
If your steps to reproduce your minimal failing example require either a spec or a
94-
workspace file, please upload it by attaching it to the text area here.
95-
96-
97-
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
98-
placeholder: >-
99-
Attach any files or compressed archives by dragging & dropping, selecting,
100-
or pasting them here.
101-
validations:
102-
required: false
103-
104-
- type: textarea
105-
attributes:
106-
label: Expected Results
107-
description: >-
108-
Describe what you expected to happen when running the steps above.
109-
placeholder: >-
110-
I expected X to happen because I assumed Y.
111-
validations:
112-
required: true
113-
114-
- type: textarea
115-
attributes:
116-
label: Actual Results
117-
description: >-
118-
Paste verbatim program or command output.
119-
Don't wrap it with triple backticks &mdash; your whole input will be
120-
turned into a code snippet automatically.
121-
render: console
122-
validations:
123-
required: true
124-
125-
- type: textarea
126-
attributes:
127-
# label: Envers version
128-
# description: >-
129-
# Paste verbatim output from `Envers --version` below, under the prompt line.
130-
# Don't wrap it with triple backticks &mdash; your whole input will be
131-
# turned into a code snippet automatically.
132-
render: console
133-
placeholder: |
134-
python -m pip show Envers
135-
validations:
136-
required: true
137-
138-
- type: checkboxes
139-
attributes:
140-
label: Code of Conduct
141-
description: |
142-
Read the [`Envers` Code of Conduct][CoC] first.
143-
144-
[CoC]: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
145-
options:
146-
- label: I agree to follow the Code of Conduct
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to report a bug in Envers!**
11+
12+
13+
14+
Verify first that your issue is not [already reported on
15+
GitHub][issue search].
16+
17+
18+
[issue search]: https://github.com/Envers/Envers/issues?q=is%3Aopen+is%3Aissue+label%3Abug
19+
20+
- type: textarea
21+
attributes:
22+
label: Summary
23+
description: Explain the problem briefly below.
24+
placeholder: >-
25+
When I try to do X with {{ cookiecutter.project_name }} and the following workspace, Y breaks or
26+
Z happens in an unexpected manner.
27+
Here are all the details I know about this problem.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
attributes:
33+
label: OS / Environment
34+
description: >-
35+
Provide information on your operating system.
36+
Something like the output of `cat /etc/os-release` on Linux or
37+
`system_profiler -detailLevel mini SPSoftwareDataType` on macOS.
38+
render: console
39+
placeholder: |
40+
# Linux
41+
$ cat /etc/os-release
42+
NAME="Ubuntu"
43+
VERSION="20.04.2 LTS (Focal Fossa)"
44+
ID=ubuntu
45+
ID_LIKE=debian
46+
PRETTY_NAME="Ubuntu 20.04.2 LTS"
47+
VERSION_ID="20.04"
48+
HOME_URL="https://www.ubuntu.com/"
49+
SUPPORT_URL="https://help.ubuntu.com/"
50+
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
51+
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
52+
VERSION_CODENAME=focal
53+
UBUNTU_CODENAME=focal
54+
55+
# macOS
56+
$ system_profiler -detailLevel mini SPSoftwareDataType | head -n 6
57+
Software:
58+
59+
System Software Overview:
60+
61+
System Version: macOS 10.15.7 (19H1323)
62+
Kernel Version: Darwin 19.6.0
63+
validations:
14764
required: true
148-
...
65+
66+
- type: textarea
67+
attributes:
68+
label: Steps to Reproduce
69+
description: >-
70+
Describe exactly how to reproduce the problem, using a minimal test-case.
71+
It would *really* help us understand your problem if you paste in the Python code
72+
that you're running.
73+
74+
75+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
76+
value: |
77+
<!--- Paste your minimal failing Python example code between the quotes below -->
78+
```python (paste below)
79+
80+
```
81+
82+
<!--- ...or if you have a failing CLI command paste it between the quotes below -->
83+
```console (paste below)
84+
85+
```
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
attributes:
91+
label: File Upload (optional)
92+
description: >-
93+
If your steps to reproduce your minimal failing example require either a spec or a
94+
workspace file, please upload it by attaching it to the text area here.
95+
96+
97+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
98+
placeholder: >-
99+
Attach any files or compressed archives by dragging & dropping, selecting,
100+
or pasting them here.
101+
validations:
102+
required: false
103+
104+
- type: textarea
105+
attributes:
106+
label: Expected Results
107+
description: >-
108+
Describe what you expected to happen when running the steps above.
109+
placeholder: >-
110+
I expected X to happen because I assumed Y.
111+
validations:
112+
required: true
113+
114+
- type: textarea
115+
attributes:
116+
label: Actual Results
117+
description: >-
118+
Paste verbatim program or command output.
119+
Don't wrap it with triple backticks &mdash; your whole input will be
120+
turned into a code snippet automatically.
121+
render: console
122+
validations:
123+
required: true
124+
125+
- type: textarea
126+
attributes:
127+
# label: Envers version
128+
# description: >-
129+
# Paste verbatim output from `Envers --version` below, under the prompt line.
130+
# Don't wrap it with triple backticks &mdash; your whole input will be
131+
# turned into a code snippet automatically.
132+
render: console
133+
placeholder: |
134+
python -m pip show Envers
135+
validations:
136+
required: true
137+
138+
- type: checkboxes
139+
attributes:
140+
label: Code of Conduct
141+
description: |
142+
Read the [`Envers` Code of Conduct][CoC] first.
143+
144+
[CoC]: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
145+
options:
146+
- label: I agree to follow the Code of Conduct
147+
required: true
148+
---
149149
This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
22
blank_issues_enabled: true
33
contact_links:
4-
- name: 🙋 Usage Questions
5-
url: https://github.com/Envers/Envers/discussions
6-
about: |
7-
Use Envers's GitHub Discussions to ask "How do I do X with Cookiecutter?".
8-
- name: 📖 Tutorial
9-
url: https://github.com/Envers/Envers
10-
about: |
11-
The Envers tutorial is continually updated and provides an in depth walkthrough
12-
of how to use the latest release of Cookiecutter.
13-
- name: 📝 Envers Code of Conduct
14-
url: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
15-
about: Expectations for how people will interact with each other on Cookiecutter's GitHub.
4+
- name: 🙋 Usage Questions
5+
url: https://github.com/Envers/Envers/discussions
6+
about: |
7+
Use Envers's GitHub Discussions to ask "How do I do X with Cookiecutter?".
8+
- name: 📖 Tutorial
9+
url: https://github.com/Envers/Envers
10+
about: |
11+
The Envers tutorial is continually updated and provides an in depth walkthrough
12+
of how to use the latest release of Cookiecutter.
13+
- name: 📝 Envers Code of Conduct
14+
url: https://github.com/Envers/Envers/coc/CODE_OF_CONDUCT.md
15+
about: Expectations for how people will interact with each other on Cookiecutter's GitHub.

0 commit comments

Comments
 (0)