chore: Professionalize repository structure#1
Open
Anwar-Projects wants to merge 7 commits into
Open
Conversation
- Move SourceCode to src/lab-pentest-runner.sh - Rename Guide to docs/GUIDE.md - Rename Installation to docs/INSTALLATION.md - Move CHANGELOG.md, README.md, LICENSE to docs/ - Make script executable - Update root README to point to new locations
Ignore: - Shell artifacts (*.log, *.tmp, *.swp) - Output files (reports/, *.html, *.pdf) - System files (.DS_Store, Thumbs.db) - IDE files (.vscode/, .idea/) - Dependencies (node_modules/)
- CONTRIBUTING.md: Contribution guidelines - CODE_OF_CONDUCT.md: Community standards - SECURITY.md: Security reporting policy
- ISSUE_TEMPLATE/bug_report.md: Bug report template - ISSUE_TEMPLATE/feature_request.md: Feature request template - pull_request_template.md: PR template
- Update README.md with comprehensive documentation - Add docs/INSTALL.md with installation steps - Add docs/CONFIGURATION.md with all options - Add docs/USAGE.md with examples and troubleshooting - Add docs/ARCHITECTURE.md with component breakdown - Add docs/FAQ.md with 25+ questions - Add Makefile with 10 targets - Add PHASE2_COMPLETE.md checklist All documentation validated against code. No secrets or credentials exposed.
- Add .shellcheckrc with appropriate disable rules for bash patterns - Add .editorconfig for consistent formatting - Add comprehensive test suite (tests/run_tests.sh) - Update Makefile with professional targets (ci, check, lint, format, all) - Add help documentation to Makefile - Ensure script follows bash best practices
Owner
Author
Professionalize repository structure, docs, and code qualityThis PR completes Phase 3 — Code Professionalization of the repository. Summary of Changes1. Repository Structure
2. Linting & Quality Assurance
3. Test Suite
4. Script Improvements
Verification Commands# Install dependencies
make install
# Run all checks
make all
# Or run individually:
make lint # Run shellcheck
make test # Run test suite
make info # Show requirements
# Clean up scan outputs
make cleanPhase-by-Phase Completion
Files Added/ModifiedReady for ReviewAll checks pass. The script maintains its lab-safe design while gaining professional tooling for development and CI/CD integration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Phase 0 & 1 Complete
Changes
Ready for review.