From b3d28fda13ff5ab4050305c4c6d0e6b842c97f9b Mon Sep 17 00:00:00 2001 From: Tutos Rive <108991712+tutosrive@users.noreply.github.com> Date: Fri, 11 Jul 2025 13:25:22 -0500 Subject: [PATCH] Create CONTRIBUTING.md Signed-off-by: Tutos Rive <108991712+tutosrive@users.noreply.github.com> --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..203c6a3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing to Bridgex 🐍 + +Thank you for considering contributing to **Bridgex**! We welcome your help to improve our graphical interface for file-to-Markdown conversion. Please follow these guidelines to help us maintain a high-quality project. + +## How to Contribute + +### 1. Reporting Issues +- Use the _GitHub Issues_ tab to report bugs, request features, or ask questions. +- Please provide as much detail as possible, including steps to reproduce if applicable. + +### 2. Suggesting Enhancements +- Open an issue and describe your idea. +- Explain how it benefits users of **Bridgex**. + +### 3. Submitting Pull Requests +- Fork the repository and create your branch from `main`. +- Follow the style and conventions used in the codebase (primarily _Python_, using _Pyside6_). +- Write clear, concise commit messages. +- Test your changes before submitting. +- Reference related issues in your PR description. + +### 4. Coding Standards +- Use Python 3.9+ compatible code. +- Follow PEP8 guidelines for Python. +- For GUI components, use Pyside6 and Qt best practices. +- Add docstrings and comments where necessary. + +### 5. Documentation +- Document new features or commands. + +### 6. Code Review +- All PRs are subject to review. Be open to feedback and willing to make improvements. + +## Code of Conduct + +Please be respectful and constructive in all interactions. Discrimination, harassment, or inappropriate behavior will not be tolerated. + +## License + +By contributing, you agree that your work will be released under the project's license (**MIT**).