Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

46 lines (28 loc) · 2.35 KB

Contributing to Fluere

Thank you for considering contributing to Fluere! Your efforts will help improve this powerful and versatile tool designed for network monitoring and analysis. This guide will provide you with an overview of how to contribute to the project.

Code of Conduct

Before you start, please read our Code of Conduct to ensure a harmonious and respectful community.

Getting Started

  1. Familiarize Yourself: Begin by reading the README to get an overview of the project.
  2. Setup: Ensure you have the necessary tools and libraries installed, as mentioned in the project prerequisites.

Issues

Reporting a New Issue

If you encounter a problem or have a suggestion, first check if a similar issue already exists. If not, feel free to open a new issue using the appropriate template.

Working on an Issue

Browse through the existing issues to find one that interests you. Use labels to filter and find relevant issues. Once you've chosen an issue, you can start working on it and submit a PR once done.

Making Changes

  1. Fork the Repository: Start by forking the fluere repository.
  2. Clone Your Fork: Clone your forked repository to your local machine.
  3. Commit Your Changes: Once you've made your changes, commit them with a meaningful commit message.
  4. Test: Ensure your changes don't break any existing functionality and add any necessary tests.

Pull Requests

  1. Open a PR: Once you're ready, open a pull request against the fluere main branch.
  2. Describe Your Changes: In the PR description, explain the changes you've made, the reason behind them, and any other relevant information.
  3. Link Issues: If your PR resolves any open issues, ensure you link them in your PR description.
  4. Review: Your PR will be reviewed by the maintainers. Address any feedback or changes requested.
  5. Merge: Once approved, your PR will be merged into the main branch.

Additional Notes

  • If you're a Windows developer, be aware of potential issues related to line endings, path separators, and Bash compatibility. Ensure your changes are compatible across different operating systems.
  • Always prioritize code quality, readability, and maintainability.

Thank you for your contribution to Fluere! Your efforts will help make the tool even better for the community.