Skip to content

Commit 56396bd

Browse files
Merge pull request #27 from python-thread/dev
Documentation update
2 parents 62395cd + 0db7e49 commit 56396bd

16 files changed

+115
-80
lines changed

.github/CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
junxiangng63@gmail.com.
63+
thread@ngjx.org.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the

.github/ISSUE_TEMPLATE/1-bug-report.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ assignees: caffeine-addictt
99

1010
# Bug report
1111
Your issue may already be reported!
12-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
12+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
13+
14+
1315

1416
## Expected Behavior
1517
<!--
@@ -19,6 +21,8 @@ If you're suggesting a change/improvement, tell us how it should work
1921
Please include screenshots and/or code snippets if applicable
2022
-->
2123

24+
25+
2226
## Current Behavior
2327
<!--
2428
If describing a bug, tell us what happens instead of the expected behavior
@@ -27,18 +31,24 @@ If suggesting a change/improvement, explain the difference from current behavior
2731
Please include screenshots and/or code snippets if applicable
2832
-->
2933

34+
35+
3036
## Is this a regression?
3137
<!--
3238
Did this behaviour use to work in previous versions?
3339
If yes, what is the latest version where this behaviour is not present?
3440
-->
3541

42+
43+
3644
## Possible Solution
3745
<!--
3846
Not obligatory, but suggest a fix/reason for the bug
3947
or ideas how to implement the addition or change
4048
-->
4149

50+
51+
4252
## Steps to Reproduce (for bugs)
4353
<!--
4454
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
@@ -48,6 +58,8 @@ Provide a link to a live example, or an unambiguous set of steps to reproduce th
4858
3.
4959
4.
5060

61+
62+
5163
## Context
5264
<!--
5365
How has this issue affected you?
@@ -58,6 +70,8 @@ Providing context helps us come up with a solution that is most useful in the re
5870
Please include screenshots and/or code snippets if applicable
5971
-->
6072

73+
74+
6175
## Your Environment
6276
<!--
6377
Include as many relevant details about the environment you experienced the bug in

.github/ISSUE_TEMPLATE/2-failing-test.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,32 @@ assignees: caffeine-addictt
99

1010
# Failing Test
1111
Your issue may already be reported!
12-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
12+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
13+
14+
1315

1416
## Which Jobs/Tests are Failing?
1517
*
1618

19+
20+
1721
## Reason for Failure
1822
<!--
1923
Why is/are this/these job/test(s) failing?
2024
What are we missing to make it pass?
2125
-->
2226

27+
28+
2329
## Media Prove
2430
<!--
2531
If applicable, add screenshots or code snippets to explain the issue
2632
If not applicable, remove this field
2733
-->
2834

35+
36+
2937
## Additional Context
3038
<!--
3139
Any other extra context or information
32-
-->
40+
-->

.github/ISSUE_TEMPLATE/3-docs-bug.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ assignees: caffeine-addictt
99

1010
# Documentation Issue Report
1111
Your issue may already be reported!
12-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
12+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
13+
14+
1315

1416
## Describe the Bug
1517
<!--
1618
A clear and concise description of the bug
1719
-->
1820

21+
22+
1923
## Steps to Reproduce
2024
<!--
2125
e.g.:
@@ -29,7 +33,9 @@ e.g.:
2933
3.
3034
4.
3135

36+
37+
3238
## Additional Context
3339
<!--
3440
Any other extra context or information
35-
-->
41+
-->

.github/ISSUE_TEMPLATE/4-feature-request.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ assignees: caffeine-addictt
99

1010
# Feature Request
1111
Your issue may already be reported!
12-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
12+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
13+
14+
1315

1416
## Is Your Feature Request Related to an Issue?
1517
<!--
@@ -19,17 +21,23 @@ E.g.:
1921
I'm always frustrated when...
2022
-->
2123

24+
25+
2226
## Describe the Solution You'd Like
2327
<!--
2428
A clear and concise description of what you'd like
2529
-->
2630

31+
32+
2733
## Describe Alternatives You've Considered
2834
<!--
2935
A clear and concise description of other alternatives you have considered
3036
-->
3137

38+
39+
3240
## Additional Context
3341
<!--
3442
Any other extra context or information
35-
-->
43+
-->

.github/ISSUE_TEMPLATE/5-enhancement-request.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ assignees: caffeine-addictt
99

1010
# Enhancement Request
1111
Your issue may already be reported!
12-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
12+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
13+
14+
1315

1416
## Is Your Enhancement Request Related to an Issue?
1517
<!--
@@ -19,17 +21,23 @@ E.g.:
1921
I'm always frustrated when...
2022
-->
2123

24+
25+
2226
## Describe the Solution You'd Like
2327
<!--
2428
A clear and concise description of what you'd like
2529
-->
2630

31+
32+
2733
## Describe Alternatives You've Considered
2834
<!--
2935
A clear and concise description of other alternatives you have considered
3036
-->
3137

38+
39+
3240
## Additional Context
3341
<!--
3442
Any other extra context or information
35-
-->
43+
-->

.github/ISSUE_TEMPLATE/6-security-report.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,17 @@ The data that must NOT be posted here:
4545

4646
# Security Report
4747
Your issue may already be reported!
48-
Please check out our [active issues](https://github.com/caffeine-addictt/FastAPI-ToDoApp/issues) before creating one.
48+
Please check out our [active issues](https://github.com/python-thread/thread/issues) before creating one.
49+
50+
4951

5052
## Describe the Security Issue
5153
<!--
5254
A clear and concise description of the security issue
5355
-->
5456

57+
58+
5559
## Steps to Reproduce
5660
<!--
5761
e.g.:
@@ -60,21 +64,29 @@ e.g.:
6064
3. See error
6165
-->
6266

67+
68+
6369
## Expected Behavior
6470
<!--
6571
A clear and concise description of the expected behavior
6672
-->
6773

74+
75+
6876
## Media Prove
6977
<!--
7078
If applicable, provide screenshots, videos and/or code snippets
7179
-->
7280

81+
82+
7383
## Additional Context
7484
<!--
7585
Any other extra context or information
7686
-->
7787

88+
89+
7890
### Your Environment
7991
<!--
8092
Include as many relevant details about the environment you experienced the bug in

.github/ISSUE_TEMPLATE/7-question-support.md

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ assignees: caffeine-addictt
99

1010
# Question or Support Request
1111

12+
13+
14+
1215
## Describe your question or ask for support
1316
<!--
1417
A clear and concise description of what your doubt is

.github/PULL_REQUEST_TEMPLATE.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
commits if your PR already received reviews or comments.
77
88
Before submitting a Pull Request, please ensure you've done the following:
9-
- 📖 Read the our Code of Conduct: https://github.com/caffeine-addictt/FastAPI-ToDoApp/blob/main/CODE_OF_CONDUCT.md
9+
- 📖 Read the our Code of Conduct: https://github.com/python-thread/thread/blob/main/CODE_OF_CONDUCT.md
1010
- 👷‍♀️ Create small PRs. In most cases this will be possible.
1111
- ✅ Provide tests for your changes.
1212
- 📝 Use descriptive commit messages.
@@ -22,8 +22,13 @@
2222
- [ ] Breaking Change
2323
- [ ] Documentation Update
2424

25+
26+
2527
## Description
2628

29+
30+
31+
2732
## Related Tickets & Documents
2833

2934
<!--
@@ -38,12 +43,16 @@ automatically close the issue.
3843
- Related Issue #
3944
- Closes #
4045

46+
47+
4148
## QA Instructions, Screenshots, Recordings
4249

4350
_Please replace this line with instructions on how to test your changes, a note
4451
on the devices and browsers this has been tested on, as well as any relevant
4552
images for UI changes._
4653

54+
55+
4756
## Added/updated tests?
4857
_We encourage you to keep the code coverage percentage at 80% and above._
4958

@@ -52,8 +61,13 @@ _We encourage you to keep the code coverage percentage at 80% and above._
5261
have not been included_
5362
- [ ] I need help with writing tests
5463

64+
65+
5566
## [optional] Are there any post deployment tasks we need to perform?
5667

68+
69+
70+
5771
## Checklist
5872
<!---
5973
Go over all the following points, and put an `x` in all the boxes that apply.

.github/SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ We appreciate your efforts to disclose your findings responsibly and will make e
66

77
To report a security issue, go to the project's issues and create a new issue using the ⚠️ Security Report 'issue template'.
88

9-
Read the instructions of this issue template carefully, and if your report could leak data or might expose how to gain access to a restricted area or break the system, please email [junxiangng63@gmail.com](mailto:junxiangng63@gmail.com) and include the word "SECURITY" in the subject line.
9+
Read the instructions of this issue template carefully, and if your report could leak data or might expose how to gain access to a restricted area or break the system, please email [thread@ngjx.org](mailto:thread@ngjx.org) and include the word "SECURITY" in the subject line.
1010

1111
We'll endeavour to respond quickly and keep you updated throughout the process.

.github/workflows/release.yml

-38
Original file line numberDiff line numberDiff line change
@@ -23,41 +23,3 @@ jobs:
2323
uses: JRubics/poetry-publish@v1.17
2424
with:
2525
pypi_token: ${{ secrets.PYPI_TOKEN }}
26-
27-
28-
# # Specifying a GitHub environment is optional, but strongly encouraged
29-
# environment: release
30-
# permissions:
31-
# # IMPORTANT: this permission is mandatory for trusted publishing
32-
# id-token: write
33-
34-
# steps:
35-
# - name: Checkout
36-
# uses: actions/checkout@v4
37-
38-
# - name: Setup Python
39-
# uses: actions/setup-python@v4
40-
# with:
41-
# python-version: "3.x"
42-
43-
# - name: Build distribution
44-
# uses: |
45-
# python3 -m pip install -U pip
46-
# python3 -m pip install -U build --user
47-
# python3 -m build
48-
49-
# - name: Store the distribution packages
50-
# uses: actions/upload-artifact@v3
51-
# with:
52-
# name: python-package-distributions
53-
# path: dist/
54-
55-
56-
# - name: Download distribution packages
57-
# uses: actions/download-artifact@v3
58-
# with:
59-
# name: python-package-distributions
60-
# path: dist/
61-
62-
# - name: Publish package distributions to PyPI
63-
# uses: pypa/gh-action-pypi-publish@release/v1

0 commit comments

Comments
 (0)