Skip to content
This repository was archived by the owner on Nov 23, 2024. It is now read-only.

Commit d6d510a

Browse files
authored
chore: add non-source files back and clean up (#57)
### Summary of Changes * Add non-source files back * Restructure files to match `stdlib` and `stdlib-examples` repos
1 parent 12bcc3c commit d6d510a

File tree

263 files changed

+18223
-1965
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

263 files changed

+18223
-1965
lines changed

.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
end_of_line = lf
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[{*.yaml,*.yml}]
12+
indent_size = 2

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @lars-reimann

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 'Bug report'
2+
description: 'Report that something does not work as expected'
3+
labels: ['bug :beetle:']
4+
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Describe the bug
10+
description: A clear and concise description of the bug.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: reproduction
16+
attributes:
17+
label: To Reproduce
18+
description: Steps to reproduce the behavior.
19+
placeholder: |
20+
1. Go to '...'
21+
2. Click on '....'
22+
3. Scroll down to '....'
23+
4. See error
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: expected-behavior
29+
attributes:
30+
label: Expected behavior
31+
description: A clear and concise description of what you expected to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: screenshots
37+
attributes:
38+
label: Screenshots (optional)
39+
description: You can attach images by clicking this area to highlight it and then dragging files in.
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional Context (optional)
47+
description: Do you have anything else to add?
48+
validations:
49+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 'Feature request'
2+
description: 'Suggest an idea for this project'
3+
labels: ['enhancement :bulb:']
4+
5+
body:
6+
- type: textarea
7+
id: related-problem
8+
attributes:
9+
label: Is your feature request related to a problem?
10+
description: A clear and concise description of what the problem is.
11+
placeholder: "Example: I'm always frustrated when [...]"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: solution
17+
attributes:
18+
label: Desired solution
19+
description: A clear and concise description of what you want to happen.
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Possible alternatives (optional)
27+
description: A clear and concise description of any alternative solutions or features you've considered.
28+
validations:
29+
required: false
30+
31+
- type: textarea
32+
id: screenshots
33+
attributes:
34+
label: Screenshots (optional)
35+
description: You can attach images by clicking this area to highlight it and then dragging files in.
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: additional-context
41+
attributes:
42+
label: Additional Context (optional)
43+
description: Do you have anything else to add?
44+
validations:
45+
required: false
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: 'Missing annotation (autogen)'
2+
description: "An annotation should have been generated automatically but wasn't."
3+
labels: ['bug :beetle:', 'missing annotation']
4+
5+
body:
6+
- type: input
7+
id: url-hash
8+
attributes:
9+
label: URL Hash
10+
description: Copy the part of the URL that starts with `#` from the address bar of your browser.
11+
placeholder: 'ex. #/sklearn/sklearn.metrics'
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: expected-annotation-type
17+
attributes:
18+
label: Expected Annotation Type
19+
description: Which annotation did you expect to be generated automatically?
20+
options:
21+
- '`@boundary`'
22+
- '`@enum`'
23+
- '`@remove`'
24+
- '`@value`'
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: expected-annotation-inputs
30+
attributes:
31+
label: Expected Annotation Inputs
32+
description: Which inputs did you expect the annotation to have? If possible, provide the JSON for the expected annotation.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: minimal-api-data
38+
attributes:
39+
label: Minimal API Data (optional)
40+
description: If possible, provide the JSON for a minimal API with the element that should have been annotated, and its ancestors.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: minimal-usage-store
46+
attributes:
47+
label: Minimal Usage Store (optional)
48+
description: If possible, provide the JSON for a minimal usage store with the element that should have been annotated, and its ancestors.
49+
validations:
50+
required: false
51+
52+
- type: textarea
53+
id: suggested-solution
54+
attributes:
55+
label: Suggested Solution (optional)
56+
description: Do you already have an idea how this problem could be fixed?
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
id: screenshots
62+
attributes:
63+
label: Screenshots (optional)
64+
description: You can attach images by clicking this area to highlight it and then dragging files in.
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: additional-context
70+
attributes:
71+
label: Additional Context (optional)
72+
description: Do you have anything else to add?
73+
validations:
74+
required: false
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: 'Wrong annotation (autogen)'
2+
description: 'An annotation was generated automatically but is incorrect.'
3+
labels: ['bug :beetle:', 'wrong annotation']
4+
5+
body:
6+
- type: input
7+
id: url-hash
8+
attributes:
9+
label: URL Hash
10+
description: Copy the part of the URL that starts with `#` from the address bar of your browser.
11+
placeholder: 'ex. #/sklearn/sklearn.metrics'
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: actual-annotation-type
17+
attributes:
18+
label: Actual Annotation Type
19+
description: Which annotation was generated automatically?
20+
options:
21+
- '`@boundary`'
22+
- '`@enum`'
23+
- '`@remove`'
24+
- '`@value`'
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
id: actual-annotation-inputs
30+
attributes:
31+
label: Actual Annotation Inputs
32+
description: Which inputs did the automatically generated annotation have? If possible, provide the JSON for the actual annotation.
33+
validations:
34+
required: true
35+
36+
- type: dropdown
37+
id: expected-annotation-type
38+
attributes:
39+
label: Expected Annotation Type
40+
description: Which annotation, if any, did you expect to be generated automatically?
41+
options:
42+
- '`@boundary`'
43+
- '`@enum`'
44+
- '`@remove`'
45+
- '`@value`'
46+
- 'No annotation'
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: expected-annotation-inputs
52+
attributes:
53+
label: Expected Annotation Inputs
54+
description: Which inputs did you expect the annotation to have? If possible, provide the JSON for the expected annotation.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: minimal-api-data
60+
attributes:
61+
label: Minimal API Data (optional)
62+
description: If possible, provide the JSON for a minimal API with the element that should have been annotated, and its ancestors.
63+
validations:
64+
required: false
65+
66+
- type: textarea
67+
id: minimal-usage-store
68+
attributes:
69+
label: Minimal Usage Store (optional)
70+
description: If possible, provide the JSON for a minimal usage store with the element that should have been annotated, and its ancestors.
71+
validations:
72+
required: false
73+
74+
- type: textarea
75+
id: suggested-solution
76+
attributes:
77+
label: Suggested Solution (optional)
78+
description: Do you already have an idea how this problem could be fixed?
79+
validations:
80+
required: false
81+
82+
- type: textarea
83+
id: screenshots
84+
attributes:
85+
label: Screenshots (optional)
86+
description: You can attach images by clicking this area to highlight it and then dragging files in.
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: additional-context
92+
attributes:
93+
label: Additional Context (optional)
94+
description: Do you have anything else to add?
95+
validations:
96+
required: false

.github/dependabot.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: 'github-actions'
9+
directory: '/'
10+
schedule:
11+
interval: 'monthly'
12+
- package-ecosystem: 'gradle'
13+
directory: '/api-editor'
14+
schedule:
15+
interval: 'monthly'
16+
- package-ecosystem: 'npm'
17+
directory: '/'
18+
schedule:
19+
interval: 'monthly'
20+
- package-ecosystem: 'npm'
21+
directory: '/api-editor/gui'
22+
schedule:
23+
interval: 'monthly'
24+
- package-ecosystem: 'pip'
25+
directory: '/library-analyzer'
26+
schedule:
27+
interval: 'monthly'

.github/linters/.flake8

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[flake8]
2+
extend-ignore =
3+
# pycodestyle (handled by black)
4+
E,
5+
W
6+
per-file-ignores =
7+
# imported but unused
8+
__init__.py: F401
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^(http|https)://localhost"
5+
},
6+
{
7+
"pattern": "^#"
8+
}
9+
]
10+
}

.github/linters/.mypy.ini

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[mypy]
2+
disallow_incomplete_defs = true
3+
disallow_untyped_defs = true
4+
ignore_missing_imports = true

.github/linters/.pylintrc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[MESSAGES CONTROL]
2+
3+
# Disable the message, report, category or checker with the given id(s). You
4+
# can either give multiple identifiers separated by comma (,) or put this
5+
# option multiple times (only on the command line, not in the configuration
6+
# file where it should appear only once). You can also use "--disable=all" to
7+
# disable everything first and then re-enable specific checks. For example, if
8+
# you want to run only the similarities checker, you can use "--disable=all
9+
# --enable=similarities". If you want to run only the classes checker, but have
10+
# no Warning level messages displayed, use "--disable=all --enable=classes
11+
# --disable=W".
12+
disable=
13+
# Default generated
14+
bad-inline-option,
15+
deprecated-pragma,
16+
file-ignored,
17+
locally-disabled,
18+
raw-checker-failed,
19+
suppressed-message,
20+
useless-suppression,
21+
use-symbolic-message-instead,
22+
# Disabled in pylint repo
23+
attribute-defined-outside-init,
24+
fixme,
25+
invalid-name,
26+
missing-docstring,
27+
protected-access,
28+
too-few-public-methods,
29+
# Handled by black
30+
format,
31+
# Handled by isort
32+
wrong-import-order,
33+
# False positives
34+
import-error,
35+
# Unwanted
36+
design,
37+
duplicate-code,
38+
metrics,
39+
logging-fstring-interpolation,
40+
too-many-nested-blocks,
41+
useless-return
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Dependency Review
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
merge_group:
7+
8+
jobs:
9+
dependency-review:
10+
if: ${{ github.event_name == 'pull_request' }}
11+
uses: lars-reimann/.github/.github/workflows/dependency-review-reusable.yml@main

0 commit comments

Comments
 (0)