Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (55 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 3.15 KB
Raw

Contributing to DOCX to Markdown Converter

Thank you for considering contributing to the DOCX to Markdown Converter project! Contributions help improve the project for everyone. Whether you want to report a bug, request a feature, improve documentation, or contribute code, your help is appreciated.

Reporting Bugs

If you find a bug or unexpected behavior, please help us by reporting it. To report a bug:

  1. Go to the GitHub issues page.
  2. Click on the "New Issue" button.
  3. Provide a clear and descriptive title.
  4. Describe the steps to reproduce the bug.
  5. Include any relevant screenshots or logs.
  6. Mention your operating system and Python version.

Requesting Features

Have an idea for a new feature or enhancement? We'd love to hear it! To request a feature:

  1. Go to the GitHub issues page.
  2. Click on the "New Issue" button.
  3. Provide a clear and descriptive title.
  4. Describe the feature and explain why it would be beneficial.
  5. Include any additional context or examples that help illustrate the feature.

Improving Documentation

Improvements to documentation are always welcome! If you find errors or areas that could be clarified, please contribute by:

  1. Forking the repository.
  2. Making your changes in a new branch.
  3. Editing the relevant markdown files.
  4. Committing your changes and pushing your branch to your fork.
  5. Creating a pull request with a clear description of your changes.

Contributing Code

Want to contribute code to the project? Follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Implement your changes in the new branch.
  4. Write tests to cover your changes.
  5. Ensure all tests pass successfully.
  6. Commit your changes and push your branch to your fork.
  7. Create a pull request with a clear description of your changes and why they are necessary.

Pull Request Guidelines

When creating a pull request, please adhere to the following guidelines:

  • Ensure your changes pass all tests.
  • Include a clear description of your changes and the problem they solve.
  • Reference any related issues in the pull request description.
  • Follow the project's coding style and conventions.

Code Style

Please follow these coding conventions:

  • Use meaningful variable and function names.
  • Write comments to explain complex code.
  • Follow PEP 8 guidelines for Python code style.

Testing

Ensure that your changes are well-tested:

  • Add new tests to cover your changes.
  • Run all existing tests to ensure nothing is broken.
  • We use pytest for testing. Make sure to add any new dependencies to requirements.txt.

Code of Conduct

Help us keep a positive and inclusive community. By participating in this project, you agree to abide by the Code of Conduct.

Getting Help

If you need help or have questions, feel free to reach out by opening an issue on the GitHub issues page.

Thank You!

Thank you for contributing to the DOCX to Markdown Converter project! Your contributions help improve the tool for all users.