Skip to content

Commit

Permalink
Merge pull request #74 from python-thread/ci/improving-ci-docs
Browse files Browse the repository at this point in the history
Improving CI and documentation
  • Loading branch information
caffeine-addictt authored Mar 17, 2024
2 parents 57e3f3f + 71a32b7 commit e76db77
Show file tree
Hide file tree
Showing 10 changed files with 47 additions and 116 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/3-docs-bug.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: "Documentation or README.md issue report"
about: "Report an issue in the project's documentation or README.md file."
title: ""
title: "[Docs] "
labels: "Documentation"
assignees: caffeine-addictt

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4-feature-request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: "Feature Request"
about: "Suggest an idea or possible new feature for this project."
title: ""
title: "[Feature] "
labels: "Type: Feature"
assignees: caffeine-addictt

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/5-enhancement-request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: "Enhancement Request"
about: "Suggest an enhancement for this project. Improve an existing feature"
title: ""
title: "[Enhancement] "
labels: "Type: Enhancement"
assignees: caffeine-addictt

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/6-security-report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: "Security Report"
about: "Report an issue to help the project improve."
title: ""
labels: "Type: Security"
title: "[Security] "
labels: ["Type: Security", "help wanted"]
assignees: caffeine-addictt

---
Expand Down Expand Up @@ -94,4 +94,4 @@ Include as many relevant details about the environment you experienced the bug i
* Version used:
* Python version:
* Link to your project:
* Operating System and version (desktop or mobile):
* Operating System and version (desktop or mobile):
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/7-question-support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: "Question or Support Request"
about: "Questions and requests for support."
title: ""
labels: "Type: Question"
title: "[Question] "
labels: ["Type: Question", "help wanted"]
assignees: caffeine-addictt

---
Expand All @@ -17,4 +17,4 @@ assignees: caffeine-addictt
A clear and concise description of what your doubt is
-->

*
*
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/8-version-checklist.md

This file was deleted.

4 changes: 3 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,6 @@ If you're unsure about any of these, don't hesitate to ask. We're here to help!
-->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have updated the documentation accordingly.
- [ ] I have incremented the version according to [semantic versioning](https://semver.org/).
- [ ] I have updated the changelog accordingly.
4 changes: 2 additions & 2 deletions .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 [thread@ngjx.org](mailto:thread@ngjx.org) 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 [contact@thread.ngjx.org](mailto:contact@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.
We'll endeavour to respond quickly and keep you updated throughout the process.
104 changes: 20 additions & 84 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 13 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,30 @@ packages = [
{ include = "thread/py.typed", from = "src" },
]
include = [{ path = "tests", format = "sdist" }]
homepage = "https://thread.ngjx.org"
repository = "https://github.com/python-thread/thread"
documentation = "https://thread.ngjx.org/docs"
keywords = ["thread", "threading", "extension", "multiprocessing"]
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Topic :: Software Development",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: Implementation :: CPython",
"Typing :: Typed",
]

[tool.poetry.urls]
Changelog = "https://github.com/python-thread/thread/releases"
Homepage = "https://thread.ngjx.org"
Documentation = "https://thread.ngjx.org/docs/v1.1.0"
Source = "https://github.com/python-thread/thread"
Download = "https://pypi.org/project/thread/#files"
"Release Notes" = "https://github.com/python-thread/thread/releases"
"Bug Tracker" = "https://github.com/python-thread/thread/issues"

[tool.poetry.scripts]
Expand All @@ -38,7 +46,6 @@ typing-extensions = "^4.9.0"

[tool.poetry.group.dev.dependencies]
pytest = "^7.4.3"
coverage = "^7.3.2"
ruff = "^0.1.5"

[build-system]
Expand Down

0 comments on commit e76db77

Please sign in to comment.