Skip to content

Documentation update #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

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

All community leaders are obligated to respect the privacy and security of the
Expand Down
16 changes: 15 additions & 1 deletion .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ assignees: caffeine-addictt

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



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



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



## Is this a regression?
<!--
Did this behaviour use to work in previous versions?
If yes, what is the latest version where this behaviour is not present?
-->



## Possible Solution
<!--
Not obligatory, but suggest a fix/reason for the bug
or ideas how to implement the addition or change
-->



## Steps to Reproduce (for bugs)
<!--
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
Expand All @@ -48,6 +58,8 @@ Provide a link to a live example, or an unambiguous set of steps to reproduce th
3.
4.



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



## Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
Expand Down
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/2-failing-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,32 @@ assignees: caffeine-addictt

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



## Which Jobs/Tests are Failing?
*



## Reason for Failure
<!--
Why is/are this/these job/test(s) failing?
What are we missing to make it pass?
-->



## Media Prove
<!--
If applicable, add screenshots or code snippets to explain the issue
If not applicable, remove this field
-->



## Additional Context
<!--
Any other extra context or information
-->
-->
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/3-docs-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ assignees: caffeine-addictt

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



## Describe the Bug
<!--
A clear and concise description of the bug
-->



## Steps to Reproduce
<!--
e.g.:
Expand All @@ -29,7 +33,9 @@ e.g.:
3.
4.



## Additional Context
<!--
Any other extra context or information
-->
-->
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/4-feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ assignees: caffeine-addictt

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



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



## Describe the Solution You'd Like
<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered
<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context
<!--
Any other extra context or information
-->
-->
12 changes: 10 additions & 2 deletions .github/ISSUE_TEMPLATE/5-enhancement-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ assignees: caffeine-addictt

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



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



## Describe the Solution You'd Like
<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered
<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context
<!--
Any other extra context or information
-->
-->
14 changes: 13 additions & 1 deletion .github/ISSUE_TEMPLATE/6-security-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,17 @@ The data that must NOT be posted here:

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



## Describe the Security Issue
<!--
A clear and concise description of the security issue
-->



## Steps to Reproduce
<!--
e.g.:
Expand All @@ -60,21 +64,29 @@ e.g.:
3. See error
-->



## Expected Behavior
<!--
A clear and concise description of the expected behavior
-->



## Media Prove
<!--
If applicable, provide screenshots, videos and/or code snippets
-->



## Additional Context
<!--
Any other extra context or information
-->



### Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/7-question-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ assignees: caffeine-addictt

# Question or Support Request




## Describe your question or ask for support
<!--
A clear and concise description of what your doubt is
Expand Down
16 changes: 15 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
commits if your PR already received reviews or comments.

Before submitting a Pull Request, please ensure you've done the following:
- 📖 Read the our Code of Conduct: https://github.com/caffeine-addictt/FastAPI-ToDoApp/blob/main/CODE_OF_CONDUCT.md
- 📖 Read the our Code of Conduct: https://github.com/python-thread/thread/blob/main/CODE_OF_CONDUCT.md
- 👷‍♀️ Create small PRs. In most cases this will be possible.
- ✅ Provide tests for your changes.
- 📝 Use descriptive commit messages.
Expand All @@ -22,8 +22,13 @@
- [ ] Breaking Change
- [ ] Documentation Update



## Description




## Related Tickets & Documents

<!--
Expand All @@ -38,12 +43,16 @@ automatically close the issue.
- Related Issue #
- Closes #



## QA Instructions, Screenshots, Recordings

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



## Added/updated tests?
_We encourage you to keep the code coverage percentage at 80% and above._

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



## [optional] Are there any post deployment tasks we need to perform?




## Checklist
<!---
Go over all the following points, and put an `x` in all the boxes that apply.
Expand Down
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ We appreciate your efforts to disclose your findings responsibly and will make e

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

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.
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.

We'll endeavour to respond quickly and keep you updated throughout the process.
38 changes: 0 additions & 38 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,41 +23,3 @@ jobs:
uses: JRubics/poetry-publish@v1.17
with:
pypi_token: ${{ secrets.PYPI_TOKEN }}


# # Specifying a GitHub environment is optional, but strongly encouraged
# environment: release
# permissions:
# # IMPORTANT: this permission is mandatory for trusted publishing
# id-token: write

# steps:
# - name: Checkout
# uses: actions/checkout@v4

# - name: Setup Python
# uses: actions/setup-python@v4
# with:
# python-version: "3.x"

# - name: Build distribution
# uses: |
# python3 -m pip install -U pip
# python3 -m pip install -U build --user
# python3 -m build

# - name: Store the distribution packages
# uses: actions/upload-artifact@v3
# with:
# name: python-package-distributions
# path: dist/


# - name: Download distribution packages
# uses: actions/download-artifact@v3
# with:
# name: python-package-distributions
# path: dist/

# - name: Publish package distributions to PyPI
# uses: pypa/gh-action-pypi-publish@release/v1
Loading