Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 1.74 KB

Contributing to BytesProcessor

First and foremost, thank you for considering contributing to BytesProcessor! Community contributions make our project grow and improve. This document provides guidelines and steps for contributing.

Guidelines

  1. Fork the Repository: Start by forking the BytesProcessor repository.

  2. Create a Branch: For each new feature or fix, create a separate branch in your fork.

  3. Commit Your Changes: Make sure to commit your changes frequently, following clear and concise commit messages.

  4. Write Tests: If applicable, write tests that cover the changes you've made.

  5. Open a Pull Request: Once you have implemented your changes, synced your fork with the main repository, and ensured all tests pass, open a pull request against the main BytesProcessor repository.

Key Areas of Contribution

Here are some points and features we're particularly interested in. If you're looking for a place to start, these are some areas that could use your help:

  • Port Filtering Logic: Enhance the utility by adding logic to filter specific ports.

  • Support for pcapng: While we currently use dpkt as our parser, we're open to suggestions on integrating other parsers that can more efficiently handle pcapng files.

  • Extended Protocol Support: The versatility of BytesProcessor can be increased by adding support for more protocols.

Questions or Suggestions?

Feel free to open an issue if you have any questions, suggestions, or feedback related to the project. We appreciate all contributions, big or small, and we're always here to help guide you!

Thank you for being a part of our community and contributing to BytesProcessor's growth and success!