Skip to content

Commit d77d01f

Browse files
xmnlabxmnlab
authored
Add initial structure (#1)
1 parent 779647d commit d77d01f

35 files changed

+8837
-43
lines changed

‎.editorconfig

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 2
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.py]
14+
indent_style = space
15+
indent_size = 4
16+
17+
[*.bat]
18+
indent_style = tab
19+
end_of_line = crlf
20+
21+
[LICENSE]
22+
insert_final_newline = true
23+
24+
[Makefile]
25+
indent_style = tab

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Create a report to help us improve
4+
labels: ["bug", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to report a bug in Data Teller!**
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/datateller-org.github.io/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: Data Teller version
128+
# description: >-
129+
# Paste verbatim output from `Data Teller --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 Data Teller
135+
validations:
136+
required: true
137+
138+
- type: checkboxes
139+
attributes:
140+
label: Code of Conduct
141+
description: |
142+
Read the [`Data Teller` Code of Conduct][CoC] first.
143+
144+
[CoC]: https://github.com/datateller-org.github.io/coc/CODE_OF_CONDUCT.md
145+
options:
146+
- label: I agree to follow the Code of Conduct
147+
required: true
148+
---
149+
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: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: 🙋 Usage Questions
5+
url: https://github.com/datateller-org.github.io/discussions
6+
about: |
7+
Use Data Teller's GitHub Discussions to ask "How do I do X with Data Teller?".
8+
- name: 📖 Tutorial
9+
url: https://github.com/datateller-org.github.io
10+
about: |
11+
The Data Teller tutorial is continually updated and provides an in depth walkthrough
12+
of how to use the latest release of Data Teller.
13+
- name: 📝 Data Teller Code of Conduct
14+
url: https://github.com/datateller-org.github.io/coc/CODE_OF_CONDUCT.md
15+
about: Expectations for how people will interact with each other on Data Teller's GitHub.

‎.github/ISSUE_TEMPLATE/documentation-report.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: 📝 Documentation Report
3+
description: Create a report for problems with the docs
4+
labels: ["docs", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to report a problem with Data Teller's documentation!**
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/datateller-org.github.io/issues?q=is%3Aopen+is%3Aissue+label%3Adocs
19+
20+
- type: textarea
21+
attributes:
22+
label: Summary
23+
description: >-
24+
Explain the problem briefly below, add suggestions to wording or structure.
25+
If there are external references that are related please link them here
26+
as well.
27+
placeholder: >-
28+
I was reading the Data Teller documentation for Data Teller version X and I'm having
29+
problems understanding Y.
30+
It would be very helpful if that got rephrased as Z.
31+
validations:
32+
required: true
33+
34+
- type: input
35+
attributes:
36+
label: Documentation Page Link
37+
description: |
38+
Paste the link to the documentation webpage that you have a question on.
39+
validations:
40+
required: true
41+
42+
- type: checkboxes
43+
attributes:
44+
label: Code of Conduct
45+
description: |
46+
Read the [`Data Teller` Code of Conduct][CoC] first.
47+
48+
[CoC]: https://github.com/datateller-org.github.io/blob/main/CODE_OF_CONDUCT.md
49+
options:
50+
- label: I agree to follow the Code of Conduct
51+
required: true
52+
---
53+
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/feature-request.yml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Suggest an idea for this project
4+
labels: ["feat/enhancement ", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
**Thank you for wanting to suggest a feature for Data Teller!**
11+
12+
13+
⚠
14+
Verify first that your issue is not [already reported on
15+
GitHub][issue search].
16+
Make sure to check the closed issues as well as it may
17+
already be implemented in a development release.
18+
19+
20+
[issue search]: https://github.com/datateller-org.github.io/issues?q=is%3Aopen+is%3Aissue+label%3Afeat%2Fenhancement
21+
22+
- type: textarea
23+
attributes:
24+
label: Summary
25+
description: >
26+
Describe the new feature/improvement you would like briefly below.
27+
28+
29+
What's the problem this feature will solve?
30+
What are you trying to do, that you are unable to achieve
31+
with the **latest** release of Data Teller?
32+
33+
34+
* Provide examples of real-world use cases that this would enable
35+
and how it solves the problem you described.
36+
37+
* How do you solve this now?
38+
39+
* Have you tried to work around the problem?
40+
41+
* Could there be a different approach to solving this issue?
42+
43+
44+
If there are external references or other GitHub Issues that are related
45+
please link them here as well.
46+
placeholder: >-
47+
I am trying to do X with Data Teller version x.y.z and I think that implementing
48+
new feature Y would be very helpful for me and every other user because of Z.
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
attributes:
54+
label: Additional Information
55+
description: |
56+
If you can, describe how the feature would be used in a mock code example.
57+
58+
**HINT:** You can paste [GitHub Gist](https://gist.github.com) links for larger files.
59+
value: |
60+
<!--- Describe what you are showing in your example -->
61+
62+
<!--- and then paste your mock Python example code between the quotes below -->
63+
```python (paste below)
64+
65+
```
66+
validations:
67+
required: false
68+
69+
- type: checkboxes
70+
attributes:
71+
label: Code of Conduct
72+
description: |
73+
Read the [`Data Teller` Code of Conduct][CoC] first.
74+
75+
[CoC]: https://github.com/datateller-org.github.io/coc/CODE_OF_CONDUCT.md
76+
options:
77+
- label: I agree to follow the Code of Conduct
78+
required: true
79+
---
80+
This template has been adopted from [pyhf](https://github.com/scikit-hep/pyhf/tree/main/.github/ISSUE_TEMPLATE)'s excellent bug report template.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Pull Request description
2+
3+
<!-- Describe the purpose of your PR and the changes you have made. -->
4+
5+
<!-- Which issue this PR aims to resolve or fix? E.g.:
6+
Fixes #004
7+
-->
8+
9+
## How to test these changes
10+
11+
<!-- Example:
12+
13+
* run `$ abc -p 1234`
14+
* open the web browser with url localhost:1234
15+
* ...
16+
-->
17+
18+
- `...`
19+
20+
<!-- Modify the options to suit your project. -->
21+
22+
## Pull Request checklists
23+
24+
This PR is a:
25+
26+
- [ ] bug-fix
27+
- [ ] new feature
28+
- [ ] maintenance
29+
30+
About this PR:
31+
32+
- [ ] it includes tests.
33+
- [ ] the tests are executed on CI.
34+
- [ ] the tests generate log file(s) (path).
35+
- [ ] pre-commit hooks were executed locally.
36+
- [ ] this PR requires a project documentation update.
37+
38+
Author's checklist:
39+
40+
- [ ] I have reviewed the changes and it contains no misspelling.
41+
- [ ] The code is well commented, especially in the parts that contain more
42+
complexity.
43+
- [ ] New and old tests passed locally.
44+
45+
## Additional information
46+
47+
<!-- Add any screenshot that helps to show the changes proposed -->
48+
49+
<!-- Add any other extra information that would help to understand the changes proposed by this PR -->
50+
51+
## Reviewer's checklist
52+
53+
Copy and paste this template for your review's note:
54+
55+
```
56+
## Reviewer's Checklist
57+
58+
- [ ] I managed to reproduce the problem locally from the `main` branch
59+
- [ ] I managed to test the new changes locally
60+
- [ ] I confirm that the issues mentioned were fixed/resolved
61+
```

0 commit comments

Comments
 (0)