Skip to content

Commit 271b04e

Browse files
authored
Merge pull request #29 from Dev2Forge/tutosrive-patch-1
Create CONTRIBUTING.md
2 parents 3a4b882 + b3d28fd commit 271b04e

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing to Bridgex 🐍
2+
3+
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.
4+
5+
## How to Contribute
6+
7+
### 1. Reporting Issues
8+
- Use the _GitHub Issues_ tab to report bugs, request features, or ask questions.
9+
- Please provide as much detail as possible, including steps to reproduce if applicable.
10+
11+
### 2. Suggesting Enhancements
12+
- Open an issue and describe your idea.
13+
- Explain how it benefits users of **Bridgex**.
14+
15+
### 3. Submitting Pull Requests
16+
- Fork the repository and create your branch from `main`.
17+
- Follow the style and conventions used in the codebase (primarily _Python_, using _Pyside6_).
18+
- Write clear, concise commit messages.
19+
- Test your changes before submitting.
20+
- Reference related issues in your PR description.
21+
22+
### 4. Coding Standards
23+
- Use Python 3.9+ compatible code.
24+
- Follow PEP8 guidelines for Python.
25+
- For GUI components, use Pyside6 and Qt best practices.
26+
- Add docstrings and comments where necessary.
27+
28+
### 5. Documentation
29+
- Document new features or commands.
30+
31+
### 6. Code Review
32+
- All PRs are subject to review. Be open to feedback and willing to make improvements.
33+
34+
## Code of Conduct
35+
36+
Please be respectful and constructive in all interactions. Discrimination, harassment, or inappropriate behavior will not be tolerated.
37+
38+
## License
39+
40+
By contributing, you agree that your work will be released under the project's license (**MIT**).

0 commit comments

Comments
 (0)