Skip to content

Commit 8d6d23a

Browse files
jackton1jackton1
committed
Merge branch 'main' into feature/migration-test-01
2 parents f0acc98 + 00c0304 commit 8d6d23a

File tree

6 files changed

+280
-1
lines changed

6 files changed

+280
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yaml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: 🐞 Bug
2+
description: Create a report to help us improve
3+
title: "[BUG] <title>"
4+
labels: [bug, needs triage]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: checkboxes
12+
attributes:
13+
label: Is there an existing issue for this?
14+
description: Please search to see if an issue already exists for the bug you encountered.
15+
options:
16+
- label: I have searched the existing issues
17+
required: true
18+
- type: textarea
19+
id: what-happened
20+
attributes:
21+
label: Describe the bug?
22+
description: A clear and concise description of what the bug is
23+
placeholder: Tell us what you see!
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: reproduce
28+
attributes:
29+
label: To Reproduce
30+
description: Steps to reproduce the behavior?
31+
placeholder: |
32+
1. Go to '...'
33+
2. Click on '....'
34+
3. Scroll down to '....'
35+
4. See error
36+
validations:
37+
required: true
38+
- type: dropdown
39+
id: os
40+
attributes:
41+
label: What OS are you seeing the problem on?
42+
multiple: true
43+
options:
44+
- linux
45+
- macos
46+
- windows
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: expected
51+
attributes:
52+
label: Expected behavior?
53+
description: A clear and concise description of what you expected to happen.
54+
placeholder: Tell us what you expected!
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: logs
59+
attributes:
60+
label: Relevant log output
61+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
62+
render: shell
63+
- type: textarea
64+
attributes:
65+
label: Anything else?
66+
description: |
67+
Links? or References?
68+
69+
Anything that will give us more context about the issue you are encountering!
70+
71+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
72+
validations:
73+
required: false
74+
- type: checkboxes
75+
id: terms
76+
attributes:
77+
label: Code of Conduct
78+
description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/CODE_OF_CONDUCT.md)
79+
options:
80+
- label: I agree to follow this project's Code of Conduct
81+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature] <title>"
4+
labels: [enhancement]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this feature request!
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: Is your feature request related to a problem? Please describe.
15+
description: |
16+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
17+
placeholder: Tell us what you see!
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: requests
22+
attributes:
23+
label: Describe the solution you'd like?
24+
description: A clear and concise description of what you want to happen.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: alternative
29+
attributes:
30+
label: Describe alternatives you've considered?
31+
description: A clear and concise description of any alternative solutions or features you've considered.
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Anything else?
37+
description: |
38+
Links? or References?
39+
40+
Add any other context or screenshots about the feature request here.
41+
42+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
43+
validations:
44+
required: false
45+
- type: checkboxes
46+
id: terms
47+
attributes:
48+
label: Code of Conduct
49+
description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md)
50+
options:
51+
- label: I agree to follow this project's Code of Conduct
52+
required: true

‎.pep8speaks.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
scanner:
2+
diff_only: True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
3+
linter: pycodestyle
4+
5+
pycodestyle: # Same as scanner.linter value. Other option is flake8
6+
max-line-length: 100 # Default is 79 in PEP 8

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ repos:
66
args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
77

88
- repo: https://github.com/pycqa/isort
9-
rev: 5.8.0
9+
rev: 5.9.1
1010
hooks:
1111
- id: isort
1212
args: ["--profile", "black", "--filter-files"]

‎.whitesource‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"scanSettings": {
3+
"baseBranches": []
4+
},
5+
"checkRunSettings": {
6+
"vulnerableCheckRunConclusionLevel": "failure",
7+
"displayMode": "diff"
8+
},
9+
"issueSettings": {
10+
"minSeverityLevel": "LOW"
11+
}
12+
}

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)