Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.7 KB

Contributing Guidelines

Thank you for your interest in contributing to html4docx! Your help is greatly appreciated. Please follow these guidelines to ensure a smooth collaboration.

This project is primarily designed for compatibility with Microsoft Word, but it currently works well with LibreOffice and Google Docs, based on our testing. The goal is to maintain this cross-platform harmony while continuing to implement fixes and updates.

⚠️ However, please note that Microsoft Word is the priority. Bugs or issues specific to other editors (e.g., LibreOffice or Google Docs) may be considered, but fixing them is secondary to maintaining full compatibility with Word.

Reporting Issues

Before opening a new issue, please check if a similar issue already exists or was recently closed.

If your issue is new, please provide a clear and detailed description, including steps to reproduce the problem and any relevant logs or screenshots.

Contributing Code

By contributing to this project, you agree to share your code under the MIT License, as specified in the LICENSE file.

Pull Request Guidelines

Code Review Process

To ensure a smooth review process, please follow these guidelines when submitting a pull request:

  1. Ensure all tests and linters pass
    • GitHub Actions will automatically run tests and linting on your PR.
    • Make sure your changes pass these checks before submitting.
  2. Creating a Pull Request
    • Fork the project and create a new branch with a clear name:
      • For new features: feature/your_update
      • For bug fixes: bug/fix_update
    • Once your updates are complete, open a PR targeting the latest release/* branch.
  3. Explain your changes
    • Provide a clear description of what your PR does.
    • If your PR fixes an issue, link to it using Fixes #issue_number.
  4. Code Review Process
    • Everyone is welcome to review and provide feedback on pull requests.
    • Please be respectful and constructive in your comments.
    • Before a pull request can be merged, it must be approved by at least one reviewer (currently only me).
  5. Pull Request
    • Fork the project, create a new branch with simple names, for new feature use feature/new_update or fixes/bugs bug/fix_update.
    • When finish your updates, open a PR for latest release/* branch.

Development Ideas

If you're looking for ways to contribute, feel free to suggest and discuss new features or improvements in the Ideas Discussion.