CONTRIBUTING.md

Contributing Guidelines

Thank you for considering contributing to our project! We appreciate your interest in helping us improve our software.

Introduction

This tool is designed to be used in incident response, pentesting and CTF's.

Types of Contributions

We welcome the following types of contributions:

• Bug reports and fixes
• Feature requests
• Code contributions
• Documentation improvements

Process for Making Contributions

Adding a new regex / extraction feature

1. Fork the project repository and create a new branch for your changes.
2. Open main.rs in your text editor and search "Hello, Contributers!" and follow the guide below.
3. Submit a pull request with your changes.

Adding a new Feature

If you Understand Regexe's and Basic Rust

To contribute to our project, please follow these steps:

1. Create a new issue describing the problem or feature you would like to work on.
2. Fork the project repository and create a new branch for your changes.
3. Make the changes to the code, following our coding standards and best practices.
4. Compare your process speeds to the latest version on a 5GB test file
5. Submit a pull request with your changes. We will review your changes as soon as possible and provide feedback if necessary.

If you dont

Create a list of examples you want to be included and create an issue.

Code Guidelines

Please follow these guidelines when writing code for our project:

• Use descriptive names for variables, functions, and classes.
• Follow snake case
• Write code that is easy to understand and maintain.
• Include Doc Strings
• Comment your code as necessary to explain what it does.

Thank You

Thank you for your interest in contributing to our project! We appreciate your help and look forward to working with you.