From c01b515c00e003bc06674266d0da5782eb45f79d Mon Sep 17 00:00:00 2001 From: Tanguy Duhamel Date: Mon, 29 Sep 2025 21:33:32 +0200 Subject: [PATCH] Issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 48 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.md | 38 +++++++++++ .github/ISSUE_TEMPLATE/workflow_submission.md | 67 +++++++++++++++++++ .github/workflows/docs-deploy.yml | 53 +++++++++++++++ .github/workflows/docs-test-deploy.yml | 28 ++++++++ 6 files changed, 242 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/workflow_submission.md create mode 100644 .github/workflows/docs-deploy.yml create mode 100644 .github/workflows/docs-test-deploy.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0247004 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,48 @@ +--- +name: 🐛 Bug Report +about: Create a report to help us improve FuzzForge +title: "[BUG] " +labels: bug +assignees: '' +--- + +## Description +A clear and concise description of the bug you encountered. + +## Environment +Please provide details about your environment: +- **OS**: (e.g., macOS 14.0, Ubuntu 22.04, Windows 11) +- **Python version**: (e.g., 3.9.7) +- **Docker version**: (e.g., 24.0.6) +- **FuzzForge version**: (e.g., 0.6.0) + +## Steps to Reproduce +Clear steps to recreate the issue: + +1. Go to '...' +2. Run command '...' +3. Click on '...' +4. See error + +## Expected Behavior +A clear and concise description of what should happen. + +## Actual Behavior +A clear and concise description of what actually happens. + +## Logs +Please include relevant error messages and stack traces: + +``` +Paste logs here +``` + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Additional Context +Add any other context about the problem here (workflow used, specific target, configuration, etc.). + +--- + +💬 **Need help?** Join our [Discord Community](https://discord.com/invite/acqv9FVG) for real-time support. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e31f032 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 💬 Community Discord + url: https://discord.com/invite/acqv9FVG + about: Join our Discord to discuss ideas, workflows, and security research with the community. + - name: 📖 Documentation + url: https://github.com/FuzzingLabs/fuzzforge_ai/tree/main/docs + about: Check our documentation for guides, tutorials, and API reference. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5b57b75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,38 @@ +--- +name: ✨ Feature Request +about: Suggest an idea for FuzzForge +title: "[FEATURE] " +labels: enhancement +assignees: '' +--- + +## Use Case +Why is this feature needed? Describe the problem you're trying to solve or the improvement you'd like to see. + +## Proposed Solution +How should it work? Describe your ideal solution in detail. + +## Alternatives +What other approaches have you considered? List any alternative solutions or features you've thought about. + +## Implementation +**(Optional)** Do you have any technical considerations or implementation ideas? + +## Category +What area of FuzzForge would this feature enhance? + +- [ ] 🤖 AI Agents for Security +- [ ] 🛠 Workflow Automation +- [ ] 📈 Vulnerability Research +- [ ] 🔗 Fuzzer Integration +- [ ] 🌐 Community Marketplace +- [ ] 🔒 Enterprise Features +- [ ] 📚 Documentation +- [ ] 🎯 Other + +## Additional Context +Add any other context, screenshots, references, or examples about the feature request here. + +--- + +💬 **Want to discuss this idea?** Join our [Discord Community](https://discord.com/invite/acqv9FVG) to collaborate with other contributors! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/workflow_submission.md b/.github/ISSUE_TEMPLATE/workflow_submission.md new file mode 100644 index 0000000..9ce4e25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/workflow_submission.md @@ -0,0 +1,67 @@ +--- +name: 🔄 Workflow Submission +about: Contribute a security workflow or module to the FuzzForge community +title: "[WORKFLOW] " +labels: workflow, community +assignees: '' +--- + +## Workflow Name +Provide a short, descriptive name for your workflow. + +## Description +Explain what this workflow does and what security problems it solves. + +## Category +What type of security workflow is this? + +- [ ] 🛡️ **Security Assessment** - Static analysis, vulnerability scanning +- [ ] 🔍 **Secret Detection** - Credential and secret scanning +- [ ] 🎯 **Fuzzing** - Dynamic testing and fuzz testing +- [ ] 🔄 **Reverse Engineering** - Binary analysis and decompilation +- [ ] 🌐 **Infrastructure Security** - Container, cloud, network security +- [ ] 🔒 **Penetration Testing** - Offensive security testing +- [ ] 📋 **Other** - Please describe + +## Files +Please attach or provide links to your workflow files: + +- [ ] `workflow.py` - Main Prefect flow implementation +- [ ] `Dockerfile` - Container definition +- [ ] `metadata.yaml` - Workflow metadata +- [ ] Test files or examples +- [ ] Documentation + +## Testing +How did you test this workflow? Please describe: + +- **Test targets used**: (e.g., vulnerable_app, custom test cases) +- **Expected outputs**: (e.g., SARIF format, specific vulnerabilities detected) +- **Validation results**: (e.g., X vulnerabilities found, Y false positives) + +## SARIF Compliance +- [ ] My workflow outputs results in SARIF format +- [ ] Results include severity levels and descriptions +- [ ] Code flow information is provided where applicable + +## Security Guidelines +- [ ] This workflow focuses on **defensive security** purposes only +- [ ] I have not included any malicious tools or capabilities +- [ ] All secrets/credentials are parameterized (no hardcoded values) +- [ ] I have followed responsible disclosure practices + +## Registry Integration +Have you updated the workflow registry? + +- [ ] Added import statement to `backend/toolbox/workflows/registry.py` +- [ ] Added registry entry with proper metadata +- [ ] Tested workflow registration and deployment + +## Additional Notes +Anything else the maintainers should know about this workflow? + +--- + +🚀 **Thank you for contributing to FuzzForge!** Your workflow will help the security community automate and scale their testing efforts. + +💬 **Questions?** Join our [Discord Community](https://discord.com/invite/acqv9FVG) to discuss your contribution! \ No newline at end of file diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 0000000..85c4909 --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -0,0 +1,53 @@ +name: Deploy Docusaurus to GitHub Pages + +on: + push: + branches: + - main + +jobs: + build: + name: Build Docusaurus + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./docs + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 24 + cache: npm + cache-dependency-path: "**/package-lock.json" + + - name: Install dependencies + run: npm ci + - name: Build website + run: npm run build + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: build + + deploy: + name: Deploy to GitHub Pages + needs: build + + # Grant GITHUB_TOKEN the permissions required to make a Pages deployment + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/docs-test-deploy.yml b/.github/workflows/docs-test-deploy.yml new file mode 100644 index 0000000..388abbc --- /dev/null +++ b/.github/workflows/docs-test-deploy.yml @@ -0,0 +1,28 @@ +name: Docusaurus test deployment + +on: + pull_request: + branches: + - main + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./docs + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 24 + cache: npm + cache-dependency-path: "**/package-lock.json" + + - name: Install dependencies + run: npm ci + - name: Test build website + run: npm run build