Thank you so much for your interest in contributing to fdir!
Your contributions help improve the tool and make it more useful for everyone.
This document outlines how to contribute in a way that keeps the project healthy, consistent, and easy to maintain.
You can contribute in several ways:
- Report bugs or issues
- Suggest new features
- Improve documentation
- Submit code fixes or enhancements
- Add tests or improve existing ones
Before opening a new issue, please:
- Search existing issues to ensure it hasn't already been reported.
- Include the following details in your report:
- Operating system and version
- Python version
fdirversion- Exact command used
- Expected behavior vs actual behavior
- Any error output or traceback
A good issue report helps me fix problems faster.
If you have a feature idea:
- Check existing issues to avoid duplicates.
- Open a new issue and describe:
- The problem you’re trying to solve
- Your proposed solution
- Any alternatives considered
- Why this feature is useful
Feature requests are evaluated based on usefulness, complexity, and alignment with project goals.