First off, thank you for your interest in CodeNavigator! Even though this project is published under a proprietary license for portfolio purposes, thoughtful feedback, bug reports, and suggestions are always welcome.
This is a proprietary portfolio project. Please read the LICENSE carefully before contributing:
- Pull Requests that add features or modify core AI logic will not be merged unless specifically invited by the author.
- Bug reports and documentation improvements are warmly welcomed.
- Any code you submit via a Pull Request may be incorporated into the project under the project's existing proprietary license.
If you wish to collaborate on a larger contribution, please email hurairac37@gmail.com first to discuss scope.
Please open a GitHub Issue with the following information:
- Description: Clear description of the bug and what you expected to happen.
- Steps to Reproduce: Minimal steps to trigger the issue.
- Environment: OS, Python version, dependency versions (
pip list). - Logs: Any relevant error messages (ensure you redact any API keys or credentials first).
- Screenshots if applicable for UI issues.
Open a GitHub Discussion or Issue tagged with the enhancement label. Include:
- A clear description of the proposed change
- Why it would benefit users of CodeNavigator
- Any alternative approaches you considered
If you do submit a patch (e.g., for a typo or documentation fix):
- Follow existing code style (PEP 8 for Python)
- Run
ruff check .before submitting - Ensure all existing tests pass:
pytest tests/
Huraira Maqbool 📧 hurairac37@gmail.com 🌐 GitHub Profile