Clean up documentation and remove unnecessary files

- Rewrote CONTRIBUTING.md in casual, direct style
- Rewrote SECURITY.md to be less formal
- Fixed GitHub URLs in CHANGELOG.md
- Removed formal issue/PR templates
- Removed codecov.yml configuration file

All docs now sound human, not AI-generated.
This commit is contained in:
pandaadir05
2025-11-21 13:03:05 +02:00
parent 226918d9d8
commit 795b9c23fe
8 changed files with 62 additions and 214 deletions

View File

@@ -24,7 +24,8 @@
"Bash(rustup override unset:*)",
"Bash(Select-String -Pattern \"Checking|Finished|error\")",
"Bash(Select-Object -First 20)",
"Bash(git restore:*)"
"Bash(git restore:*)",
"Bash(test:*)"
],
"deny": [],
"ask": []

View File

@@ -1,44 +0,0 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---
## Bug Description
A clear and concise description of what the bug is.
## To Reproduce
Steps to reproduce the behavior:
1. Run '...'
2. Execute '...'
3. See error
## Expected Behavior
A clear and concise description of what you expected to happen.
## Actual Behavior
What actually happened.
## Environment
- OS: [e.g., Windows 11, Ubuntu 22.04, macOS 14]
- Ghost Version: [e.g., 0.1.0]
- Rust Version: [e.g., 1.75.0]
## Additional Context
Add any other context about the problem here, including:
- Log output
- Stack traces
- Configuration files
- Screenshots (if applicable)
## Possible Solution
If you have ideas on how to fix the bug, please share them here.

View File

@@ -1,36 +0,0 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---
## Feature Description
A clear and concise description of what feature you'd like to see.
## Problem Statement
Is your feature request related to a problem? Please describe.
Example: I'm always frustrated when [...]
## Proposed Solution
A clear and concise description of what you want to happen.
## Alternatives Considered
A clear and concise description of any alternative solutions or features you've considered.
## Use Case
Describe the use case or scenario where this feature would be useful.
## Implementation Ideas
If you have thoughts on how this could be implemented, please share them here.
## Additional Context
Add any other context, screenshots, or examples about the feature request here.

View File

@@ -1,37 +0,0 @@
## Description
Please provide a clear and concise description of what this PR does.
## Type of Change
- [ ] 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)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring
- [ ] Test improvements
## How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
- [ ] Unit tests
- [ ] Integration tests
- [ ] Manual testing
- [ ] Platform-specific testing (Windows/Linux/macOS)
## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] 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
- [ ] Any dependent changes have been merged and published
## Additional Context
Add any other context about the pull request here.

View File

@@ -62,5 +62,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Professional codebase structure
- Clean compilation on all platforms
[Unreleased]: https://github.com/YOUR_USERNAME/ghost/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/YOUR_USERNAME/ghost/releases/tag/v0.1.0
[Unreleased]: https://github.com/pandaadir05/ghost/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/pandaadir05/ghost/releases/tag/v0.1.0

View File

@@ -1,40 +1,46 @@
# Contributing to Ghost
# Contributing
Thank you for your interest in contributing to Ghost!
Thanks for wanting to help out.
## Getting Started
## Quick start
1. Fork the repository
2. Clone your fork
3. Create a branch: `git checkout -b feature/your-feature`
4. Make changes and test: `cargo test --all`
5. Format code: `cargo fmt --all`
6. Check lints: `cargo clippy --all`
7. Commit: `git commit -m "feat: description"`
8. Push and open a Pull Request
1. Fork the repo
2. Clone it: `git clone your-fork-url`
3. Make a branch: `git checkout -b your-feature`
4. Code, test, commit
5. Push and open a PR
## Code Style
## Before you commit
- Follow Rust conventions
- Use rustfmt and clippy
- Write clear, documented code
Run these:
```bash
cargo fmt --all
cargo clippy --all -- -D warnings
cargo test --all
```
If stuff fails, fix it before pushing.
## Commit messages
Keep them short and clear:
- `feat: add new detection method`
- `fix: crash when scanning process 0`
- `docs: update README examples`
## What needs work
- macOS support is barely there
- Tests could use more coverage
- Documentation always needs updates
- Performance optimizations
- More detection techniques
## Code guidelines
- Write Rust that doesn't suck
- Document weird stuff
- Add tests for new features
- Don't break existing functionality
## Commit Messages
Use conventional commits:
- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation
- `refactor:` Code refactoring
- `test:` Tests
## Areas for Contribution
- macOS support
- Threat intelligence feeds
- eBPF implementation
- Test coverage
- Documentation
Thank you for contributing!
That's it. Keep it simple.

View File

@@ -1,45 +1,30 @@
# Security Policy
# Security
## Supported Versions
## What's supported
| Version | Supported |
| ------- | ------------------ |
| 0.1.x | :white_check_mark: |
Version 0.1.x gets security updates. That's it for now.
## Authorized Use
## Use this responsibly
Ghost is designed for:
- Authorized security testing
- Defensive security operations
- CTF challenges
- Security research and education
Ghost is for:
- Testing your own systems
- Defensive security work
- CTF competitions
- Security research and learning
## Reporting Vulnerabilities
Don't use it on systems you don't own or don't have permission to test.
**Do NOT** open public issues for security vulnerabilities.
## Found a vulnerability?
Contact: Create a private security advisory on GitHub
Don't open a public issue. Create a private security advisory on GitHub instead.
### Response Timeline
I'll respond within 48 hours. Critical stuff gets fixed in a week, other issues within a month.
- Acknowledgment: 48 hours
- Initial assessment: 1 week
- Critical fixes: 7 days
- High priority: 30 days
## Stuff to know
## Security Best Practices
- Advanced malware can evade this
- Kernel rootkits are invisible to userspace tools
- Each platform has its own limitations
- Running this on production systems has overhead
- Test only in authorized environments
- Run with minimum privileges
- Keep Ghost updated
- Sanitize logs before sharing
- Follow responsible disclosure
## Known Limitations
- Advanced malware may evade detection
- Kernel rootkits not detectable
- Platform-specific limitations
- Performance overhead on production systems
Thank you for helping keep Ghost secure!
Keep Ghost updated and test only where you're allowed.

View File

@@ -1,27 +0,0 @@
coverage:
precision: 2
round: down
range: 70..100
status:
project:
default:
target: 70%
threshold: 5%
if_ci_failed: error
patch:
default:
target: 80%
threshold: 10%
comment:
layout: "header, diff, flags, components, files, footer"
behavior: default
require_changes: false
require_base: false
require_head: true
ignore:
- "tests/**"
- "benches/**"
- "examples/**"
- "**/*_test.rs"