Skip to content

Commit 7d097b3

Browse files
BinoyOza-oktaBinoyOza-okta
committed
- Updated README.md file to include older changes.
- Updated setup.mustache and setup.py to include dcp email. - Added templates for GitHub issues, feature request and bug report feature.
1 parent 9d8d88e commit 7d097b3

File tree

8 files changed

+931
-13
lines changed

8 files changed

+931
-13
lines changed

‎.github/ISSUE_TEMPLATE/00_bug_report.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: "Bug"
2+
labels: ["bug"]
3+
description: "For when something is there, but doesn't work how it should."
4+
body:
5+
- type: textarea
6+
id: community-note
7+
attributes:
8+
label: Community Note
9+
description: Please keep this note for the community.
10+
value: |
11+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request.
12+
* Please do not leave _+1_ or _me too_ comments, they generate extra noise for issue followers and do not help prioritize the request.
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment.
14+
Before submitting a bug report, we ask that you first [search existing issues](https://github.com/okta/okta-sdk-python/issues) and [pull requests](https://github.com/okta/okta-sdk-python/pulls) to see if someone else may have experienced the same issue or may have already submitted a fix for it.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: sdk-version
19+
attributes:
20+
label: Python Version & Okta SDK Version(s)
21+
description: |
22+
Please run `python --version` and `pip list okta` to show the Python and Okta SDK versions and paste the output here.
23+
If you are not running the latest version of the SDK, please upgrade because your issue may have already been fixed.
24+
value: |
25+
Python vX.X.X
26+
okta X.X.X
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: affected-code
31+
attributes:
32+
label: Affected Class/Method(s)
33+
description: Please list the affected classes or methods. Use `okta.*` if all parts of the SDK are affected.
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: customer_info
38+
attributes:
39+
label: Customer Information
40+
description: |
41+
Please provide your organization name, and whether you are a paid customer or using the free developer edition.
42+
value: |
43+
Organization Name: <your-org-name>
44+
Paid Customer: <yes/no>
45+
- type: textarea
46+
id: code-snippet
47+
attributes:
48+
label: Code Snippet
49+
description: |
50+
Please provide a minimal, runnable code snippet that reproduces the bug. Use [markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code).
51+
value: |
52+
```python
53+
# Your code here
54+
```
55+
- type: textarea
56+
id: debug-output
57+
attributes:
58+
label: Debug Output / Traceback
59+
description: |
60+
Please provide a link to a GitHub Gist containing the complete traceback or any relevant debug output. Please **don't** paste the output in the issue; just paste a link to the Gist.
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: expected-behavior
65+
attributes:
66+
label: Expected Behavior
67+
description: What should have happened?
68+
validations:
69+
required: true
70+
- type: textarea
71+
id: actual-behavior
72+
attributes:
73+
label: Actual Behavior
74+
description: What actually happened?
75+
validations:
76+
required: true
77+
- type: textarea
78+
id: steps-to-reproduce
79+
attributes:
80+
label: Steps to reproduce
81+
description: Please list the steps required to reproduce the issue.
82+
value: "1. Run the code snippet provided above."
83+
validations:
84+
required: true
85+
- type: textarea
86+
id: references
87+
attributes:
88+
label: References
89+
description: |
90+
Are there any other GitHub issues (open or closed) or pull requests that should be [linked](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) here? Vendor documentation?

‎.github/ISSUE_TEMPLATE/01_question.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: "Question"
2+
labels: ["question"]
3+
description: "If you have a question, please check out our community resources first!"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Issues on GitHub are intended for bugs or feature requests with the SDK codebase. If you have a support request or question, please use one of these resources instead 👍.
9+
10+
* [Okta Community Forum](https://devforum.okta.com/) for questions and community support.
11+
* [Okta Support](https://support.okta.com/) for paid customers.
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: Question
16+
value: Please use the resources listed above instead of submitting a question with this form.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: customer_info
21+
attributes:
22+
label: Customer Information
23+
description: |
24+
Please provide your organization name, and whether you are a paid customer or using the free developer edition.
25+
value: |
26+
Organization Name: <your-org-name>
27+
Paid Customer: <yes/no>

‎.github/ISSUE_TEMPLATE/02_documentation.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Report a Documentation Error
2+
description: Choose this option if you've found an error in the SDK documentation or contributor guides.
3+
labels:
4+
- documentation
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Thank you for raising a documentation issue!
10+
11+
This form is meant to alert the maintainers to issues with the SDK documentation (such as docstrings, examples, or ReadMe), or the [contributors guide](https://github.com/okta/okta-sdk-python/blob/master/.github/CONTRIBUTING.md).
12+
13+
We ask that you first [search existing issues](https://github.com/okta/okta-sdk-python/labels/documentation) and [pull requests](https://github.com/okta/okta-sdk-python/pulls) to see if someone else may have already noticed the same issue or has already submitted a fix for it.
14+
15+
- type: textarea
16+
id: documentation_link
17+
attributes:
18+
label: Documentation Link(s)
19+
description: |
20+
Please link to the affected page(s) or the location in the code with the incorrect documentation.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description: |
28+
Please leave a brief description of the documentation issue, including what the documentation currently says and, if possible, what it should say.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: customer_info
33+
attributes:
34+
label: Customer Information
35+
description: |
36+
Please provide your organization name, and whether you are a paid customer or using the free developer edition.
37+
value: |
38+
Organization Name: <your-org-name>
39+
Paid Customer: <yes/no>
40+
- type: textarea
41+
id: references
42+
attributes:
43+
label: References
44+
description: |
45+
Where possible, please supply links to Okta API documentation and/or other GitHub issues or pull requests that give additional context.

‎.github/ISSUE_TEMPLATE/03_feature_request.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "Enhancement"
2+
labels: ["enhancement"]
3+
description: "For when something (a method, parameter, etc.) is missing, and should be added."
4+
body:
5+
- type: textarea
6+
id: community-note
7+
attributes:
8+
label: Community Note
9+
description: Please keep this note for the community.
10+
value: |
11+
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request.
12+
* Please do not leave _+1_ or _me too_ comments, they generate extra noise for issue followers and do not help prioritize the request.
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Description
20+
description: Please leave a helpful description of the feature request here. Including use cases and why it would help you is a great way to convince maintainers to spend time on it.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: affected-code
25+
attributes:
26+
label: New or Affected Class/Method(s)
27+
description: Please list the new or affected classes or methods.
28+
value: |
29+
* okta.client.XXXXX
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: customer_info
34+
attributes:
35+
label: Customer Information
36+
description: |
37+
Please provide your organization name, and whether you are a paid customer or using the free developer edition.
38+
value: |
39+
Organization Name: <your-org-name>
40+
Paid Customer: <yes/no>
41+
- type: textarea
42+
id: potential-code
43+
attributes:
44+
label: Potential Code Snippet
45+
description: |
46+
Propose what you think the code to take advantage of this feature should look like. We may not use it verbatim, but it's helpful in understanding your intent.
47+
Use [markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) to format the code.
48+
value: |
49+
```python
50+
# Your proposed code here
51+
```
52+
- type: textarea
53+
id: references
54+
attributes:
55+
label: References
56+
description: |
57+
Are there any other GitHub issues (open or closed) or pull requests that should be [linked](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) here? Okta API documentation?

‎.github/ISSUE_TEMPLATE/04_other.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Other
2+
description: Choose this option if your issue does not fit any of the other forms.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
## Thank you for raising an issue!
8+
9+
This form is a catch-all for issues that do not fit into one of the other categories. Please provide as much information, context, or reference material as possible.
10+
11+
Before submission, we ask that you first [search existing issues](https://github.com/okta/okta-sdk-python/issues) and [pull requests](https://github.com/okta/okta-sdk-python/pulls) to see if someone else may have already reported your issue.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Description
17+
description: |
18+
Please provide a brief description of what you're looking to report to the maintainers.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: references
23+
attributes:
24+
label: Important Facts and References
25+
description: |
26+
Where possible, please supply links to documentation and/or other GitHub issues or pull requests that give additional context.
27+
validations:
28+
required: false
29+
- type: textarea
30+
id: customer_info
31+
attributes:
32+
label: Customer Information
33+
description: |
34+
Please provide your organization name, and whether you are a paid customer or using the free developer edition.
35+
value: |
36+
Organization Name: <your-org-name>
37+
Paid Customer: <yes/no>
38+
- type: dropdown
39+
id: will_contribute
40+
attributes:
41+
label: Would you like to implement a relevant change?
42+
description: |
43+
Indicate to the maintainers whether you plan to implement a change related to this. This helps prevent duplication of effort.
44+
45+
If this would be your first contribution, refer to the [contributors guide](https://github.com/okta/okta-sdk-python/blob/master/.github/CONTRIBUTING.md) for tips on getting started.
46+
options:
47+
- "No"
48+
- "Yes"
49+
multiple: false
50+
validations:
51+
required: true

0 commit comments

Comments
 (0)