Community standards (#5)

copyleftdev · zuub-don · web-flow · commit 5f45dd832fa7 · 2025-03-22T15:42:37.000-07:00
* remove results.sqlite and cache files from git tracking

* Add GitHub Community Standards files

- Add CONTRIBUTING.md with guidelines for contributors
- Add CODE_OF_CONDUCT.md based on Contributor Covenant
- Add SECURITY.md with vulnerability reporting guidelines
- Add SUPPORT.md with user support information
- Add issue templates for bug reports and feature requests
- Add pull request template

These files improve project documentation and make it more welcoming for contributors, aligning with the code quality improvements already implemented in the project.

---------

Co-authored-by: Don Johnson &lt;donj@zuub.com&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,53 @@
+---
+name: Bug Report
+about: Create a report to help us improve FATT
+title: '[BUG] '
+labels: 'bug'
+assignees: ''
+---
+
+## Bug Description
+A clear and concise description of what the bug is.
+
+## Steps To Reproduce
+Steps to reproduce the behavior:
+1. Run command '...'
+2. Use configuration '...'
+3. Scan domain '...'
+4. See error
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+## Actual Behavior
+A clear and concise description of what actually happened.
+
+## Environment
+ - FATT Version: [e.g. 0.1.1]
+ - OS: [e.g. Ubuntu 22.04, Windows 11, macOS 14.0]
+ - Rust Version: [e.g. 1.75.0]
+ - Installation Method: [e.g. cargo install, built from source]
+
+## Configuration
+Please include relevant configuration files or commands (with sensitive information redacted):
+```yaml
+# Example configuration
+```
+
+## Error Logs
+If applicable, add error logs or terminal output:
+```
+Error output here
+```
+
+## Target Information
+If applicable, provide non-sensitive information about the target domains or paths being scanned.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
+## Additional Context
+Add any other context about the problem here.
+
+## Possible Solution
+If you have suggestions on how to fix the issue, please describe them here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,34 @@
+---
+name: Feature Request
+about: Suggest an idea for FATT
+title: '[FEATURE] '
+labels: 'enhancement'
+assignees: ''
+---
+
+## Problem Statement
+A clear and concise description of what problem you're trying to solve. 
+Ex. I'm always frustrated when [...]
+
+## Proposed Solution
+A clear and concise description of what you want to happen.
+
+## Alternatives Considered
+A description of any alternative solutions or features you've considered.
+
+## Use Case
+How would this feature be used, and who would use it?
+
+## Implementation Ideas
+If you have ideas about how this could be implemented, please share them here.
+
+## Screenshots or Mockups
+If applicable, add screenshots or mockups to help explain your feature request.
+
+## Additional Context
+Add any other context about the feature request here.
+
+## Would you be willing to work on this feature?
+- [ ] Yes, I'd like to implement this feature
+- [ ] I could help with parts of this implementation
+- [ ] I can't implement this myself
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,50 @@
+# Pull Request
+
+## Description
+
+Please provide a clear and concise description of what this PR implements or fixes.
+
+## Related Issue
+
+Fixes #(issue number)
+
+If there's no existing issue, please describe why this change is necessary.
+
+## Type of Change
+
+Please check the options that are relevant:
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Performance improvement
+- [ ] Code refactoring (no functional changes)
+- [ ] Documentation update
+- [ ] Test coverage improvement
+- [ ] CI/CD pipeline changes
+
+## Checklist
+
+- [ ] I have read the [CONTRIBUTING](../CONTRIBUTING.md) document
+- [ ] My code follows the code style of this project (run `cargo fmt`)
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have updated the documentation accordingly
+- [ ] I have run `cargo clippy` and addressed any warnings
+- [ ] I have added appropriate comments to complex code sections
+- [ ] My changes generate no new warnings
+- [ ] Any dependent changes have been merged and published (if relevant)
+
+## Testing Strategy
+
+Please describe the tests that you added or modified to verify your changes:
+
+- Test case 1
+- Test case 2
+- ...
+
+## Screenshots (if applicable)
+
+## Additional Context
+
+Add any other context about the pull request here.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,61 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainers. All complaints will be reviewed and
+investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,66 @@
+# Contributing to FATT
+
+Thank you for your interest in contributing to FATT (Find All The Things)! This document provides guidelines and instructions for contributing to this project.
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report, reproduce the issue, and find related reports.
+
+Before creating bug reports, please check the issue tracker as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **Include screenshots or animated GIFs** which show you following the described steps and clearly demonstrate the problem.
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Explain why this enhancement would be useful** to most FATT users.
+
+### Pull Requests
+
+* Fill in the required template
+* Follow the Rust style guidelines
+* Include appropriate test cases
+* Run `cargo fmt` and `cargo clippy` before submitting
+* Ensure all tests pass locally before submitting your PR
+
+## Development Workflow
+
+1. Fork the repository
+2. Create a new branch: `git checkout -b my-branch-name`
+3. Make your changes
+4. Run tests: `cargo test`
+5. Run linters: `cargo fmt` and `cargo clippy`
+6. Submit a pull request
+
+## Styleguides
+
+### Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+### Rust Styleguide
+
+* Follow the official [Rust style guidelines](https://doc.rust-lang.org/1.0.0/style/README.html)
+* Use `cargo fmt` to format your code
+* Ensure your code passes `cargo clippy` without warnings
+
+## License
+
+By contributing to FATT, you agree that your contributions will be licensed under the project's license.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,36 @@
+# Security Policy
+
+## Supported Versions
+
+Currently, we support the following versions of FATT with security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.1   | :white_check_mark: |
+| 0.1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of FATT seriously. If you believe you've found a security vulnerability, please follow these steps:
+
+1. **Do not disclose the vulnerability publicly**
+2. **Email the project maintainer directly** or create a private security advisory in the GitHub repository
+3. **Include details** such as:
+   - A description of the vulnerability
+   - Steps to reproduce
+   - Potential impact
+   - Suggested fixes if you have them
+
+We will acknowledge receipt of your vulnerability report as soon as possible and will work on addressing it.
+
+## Security Features
+
+FATT is a security tool itself, designed to help identify potential security issues in web applications. As such, we strive to maintain high security standards in our own codebase.
+
+- All dependencies are regularly updated to address known vulnerabilities
+- We use Rust's memory safety features to minimize the risk of memory-related security issues
+- The codebase undergoes regular security reviews
+
+## Updates and Mitigations
+
+Security updates will be released as soon as possible after a vulnerability is confirmed and fixed. Users are encouraged to stay updated with the latest version of FATT.
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,54 @@
+# Support for FATT
+
+This document outlines various ways to get help with FATT (Find All The Things). Please read through this document before reaching out for support.
+
+## Documentation
+
+Before seeking support, please check the documentation:
+
+- **README.md**: Basic overview and installation instructions
+- **[API Documentation](https://docs.rs/fatt)**: Auto-generated documentation from code comments (once published)
+- **Examples directory**: Contains example usage patterns
+
+## Getting Help
+
+There are several ways to get support for FATT:
+
+### Issues on GitHub
+
+For bug reports, feature requests, or general questions:
+
+1. Search [existing issues](https://github.com/copyleftdev/fatt/issues) to see if your problem has already been reported or discussed.
+2. If not, create a [new issue](https://github.com/copyleftdev/fatt/issues/new/choose) using the appropriate template.
+
+### Usage Questions
+
+For questions about using FATT:
+
+1. Start by checking the documentation and examples
+2. Search [existing issues](https://github.com/copyleftdev/fatt/issues) for similar questions
+3. If your question hasn't been addressed, [create a new issue](https://github.com/copyleftdev/fatt/issues/new/choose) with the question label
+
+## Reporting Bugs
+
+When reporting bugs, please include:
+
+- FATT version you're using
+- Operating system and version
+- Steps to reproduce the issue
+- Expected behavior vs. actual behavior
+- Any error messages or logs (with sensitive information redacted)
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on bug reporting.
+
+## Security Issues
+
+For security vulnerabilities, please follow the process outlined in our [SECURITY.md](SECURITY.md) file instead of creating a public issue.
+
+## Commercial Support
+
+Currently, there is no commercial support available for FATT.
+
+## Contributing
+
+If you're interested in contributing to FATT to add features or fix bugs, please see our [CONTRIBUTING.md](CONTRIBUTING.md) guide.
diff --git a/cache/dns_cache/conf b/cache/dns_cache/conf
diff --git a/cache/dns_cache/db b/cache/dns_cache/db
diff --git a/results.sqlite b/results.sqlite
