mirror of
https://github.com/Z4nzu/hackingtool
synced 2026-05-23 08:58:22 +00:00
06245219c9
README.md:
- Modern centered header with full badge row
- Stats banner: 17 categories, 150+ tools
- What's new as a comparison table
- Tool category table with per-category counts
- Complete tool listing with star markers for new tools
- Contributing section with enforced title formats for issues and PRs
- Star History chart (Z4nzu/hackingtool)
- Cleaned up Installation, Requirements, Social sections
README_template.md:
- Full redesign matching README.md layout
- {{toc}} and {{tools}} placeholders preserved for generate_readme.py
- Contributing section with title format rules embedded in template
.github/ISSUE_TEMPLATE/bug_report.md:
- Remove irrelevant browser/smartphone sections
- Add tool name, category, error output, environment table
.github/ISSUE_TEMPLATE/feature_request.md:
- Tighten to 4 focused fields, note tool additions use separate template
.github/ISSUE_TEMPLATE/tool_request.md (new):
- Structured template for new tool suggestions
- Required fields: name, URL, category, OS, install/run commands, reason
- Enforced title format: [Tool Request] ToolName - Category
.github/PULL_REQUEST_TEMPLATE.md (new):
- PR checklist for new tool additions and other change types
- Enforced title format: [New Tool] / [Fix] / [Improve]
- All required class fields listed as checklist items
.github/workflows/lint_python.yml:
- actions/checkout v3 -> v4, setup-python v4 -> v5
- python-version: 3.x -> 3.12 (project requires 3.10+)
- ruff target-version: py37 -> py310
- ruff --show-source -> --output-format=full (updated flag name)
- Remove deprecated safety check command
.github/workflows/test_install.yml:
- actions/checkout v3 -> v4, setup-python v4 -> v5
- python-version: 3.x -> 3.12
- Replace fragile matrix of hard-coded menu numbers with
two simple smoke tests: launch+quit, and navigate+back
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
<!--
|
|
TITLE FORMAT
|
|
─────────────────────────────────────────────────────────────────
|
|
Adding a new tool → [New Tool] ToolName — Category
|
|
Bug fix → [Fix] Short description of what was fixed
|
|
Improvement → [Improve] Short description
|
|
─────────────────────────────────────────────────────────────────
|
|
PRs without a properly formatted title may be closed without review.
|
|
-->
|
|
|
|
## Type of Change
|
|
- [ ] New tool addition
|
|
- [ ] Bug fix
|
|
- [ ] Improvement / refactor
|
|
- [ ] Documentation update
|
|
|
|
---
|
|
|
|
## For New Tool Additions — Required Fields
|
|
|
|
| Field | Value |
|
|
|---|---|
|
|
| **Tool name** | |
|
|
| **GitHub URL** | |
|
|
| **Category** | |
|
|
| **Supported OS** | Linux / macOS / Both |
|
|
| **Install method** | pip / go install / apt / git clone |
|
|
|
|
**Why should it be added?**
|
|
<!-- What gap does this fill? Min 2 sentences. -->
|
|
|
|
**Is the tool actively maintained?**
|
|
<!-- Link to last release / commit -->
|
|
|
|
---
|
|
|
|
## Checklist
|
|
|
|
- [ ] Title follows the format above
|
|
- [ ] New tool class added to the correct `tools/*.py` file
|
|
- [ ] `TITLE`, `DESCRIPTION`, `INSTALL_COMMANDS`, `RUN_COMMANDS`, `PROJECT_URL` all set
|
|
- [ ] `SUPPORTED_OS` set correctly (`["linux"]` / `["linux", "macos"]`)
|
|
- [ ] Tool added to the `TOOLS` list in the collection class at the bottom of the file
|
|
- [ ] No new dependencies added to `requirements.txt` without discussion
|
|
- [ ] Tested locally — install and run commands work
|