Hi! Thank you for considering contributing to **Rustfuscator** — an open-source toolkit for source-level code obfuscation in Rust.
Whether you're fixing a bug, improving documentation, writing tests, opening issues, or just dropping a comment: **your contribution is appreciated**.
---
## Ways to Contribute
You can help in many ways:
- Add new features or fix bugs
- Report issues or confusing behaviors
- Improve docs or comments
- Write tests or example code
- Join discussions or share feedback
- Propose improvements or ideas
> Even just opening an issue to say “this part was unclear” or “nice project!” is helpful ❤️
---
## New to code obfuscation?
No problem! If you’re new to obfuscation techniques or want more context before diving in, check out this introductory document:
👉 [`obfuscation_fundamentals.md`](https://gianiac.github.io/rustfuscator/obfuscation_fundamentals.html)
---
## Getting Started
Fork the repository and Clone your fork:
```bash
git clone https://github.com/<your-username>/rustfuscator
cd rustfuscator
```
Create a feature branch:
```bash
git checkout -b feature/your-feature-name
```
Build and test:
```bash
cargo build
cargo test --workspace
```
Pull Requests (PRs):
- Focus each PR on a single change
- Reference related issues (e.g. Closes #12)
- Add relevant tests and documentation
- Describe what your PR does and why
Issues, Ideas, and Questions:
- Open an issue
- Label questions or feedback with question
- Want to help but not sure how? Look for good first issue or help wanted
Code of Conduct: https://www.rust-lang.org/policies/code-of-conduct
Let’s keep this a welcoming, respectful, and inclusive space for everyone.
Every contribution counts — from typos to new features.
Thank you for helping make Rustfuscator better, one commit at a time. ❤️