Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (63 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

86 lines (63 loc) · 4.17 KB

Contributing to Text Extractor

Thank you for your interest in contributing to Text Extractor! We welcome contributions from the community to help improve this open-source project. This document outlines the guidelines for contributing, whether you're reporting bugs, suggesting features, or submitting code.

How to Contribute

1. Reporting Bugs

  • Check the Issues page to ensure the bug hasn't already been reported.
  • Use the Bug Report issue template when creating a new issue.
  • Provide a clear description, steps to reproduce, expected behavior, actual behavior, and any relevant screenshots or logs.
  • Specify your operating system (Windows, macOS, Linux) and Python version.

2. Suggesting Features

  • Check the Issues page to see if the feature has already been proposed.
  • Use the Feature Request issue template to submit your idea.
  • Clearly describe the feature, its use case, and why it would benefit the project.
  • Be open to feedback and discussion from the community.

3. Submitting Code

  • Fork the repository and create a new branch for your changes (git checkout -b feature/your-feature-name or git checkout -b bugfix/your-bugfix-name).
  • Follow the coding style and conventions used in the project (e.g., PEP 8 for Python code).
  • Ensure your code is well-documented and includes appropriate comments.
  • Write tests for new features or bug fixes where applicable.
  • Update the documentation (e.g., README.md or in-app Help tab) if your changes affect usage.
  • Commit your changes with a clear message (e.g., Add file sorting feature or Fix UTF-16 encoding bug).
  • Push your branch to your fork and create a pull request (PR) using the Pull Request template.
  • Ensure your PR passes all checks and addresses any feedback during review.

4. Other Contributions

  • Improve documentation by fixing typos, clarifying instructions, or adding examples.
  • Translate the interface or documentation into other languages.
  • Share feedback or ideas via discussions or issues.
  • Promote the project by starring the repository or sharing it with others.

Getting Started

  1. Fork the Repository:

    • Click the "Fork" button on the Text Extractor GitHub page.
    • Clone your fork: git clone https://github.com/YOUR_USERNAME/Text-Extractor.git.

  2. Set Up the Development Environment:

    • Ensure you have Python 3.9+ installed.
    • Install dependencies: pip install -r requirements.txt.
    • Install Briefcase for packaging: pip install briefcase.
    • Run the app locally: briefcase run.

  3. Make Changes:

    • Create a new branch for your work.
    • Implement your changes, test thoroughly, and update documentation if needed.

  4. Submit a Pull Request:

    • Push your changes to your fork.
    • Open a PR against the main branch of the original repository.
    • Use the PR template and provide a detailed description of your changes.
    • Respond to feedback and make updates as needed.

Code of Conduct

All contributors are expected to adhere to our Code of Conduct. Be respectful, inclusive, and collaborative in all interactions.

Security

If you discover a security vulnerability, please follow the guidelines in our Security Policy. Do not disclose vulnerabilities publicly until they are resolved.

Review Process

  • Pull requests are reviewed by the maintainers (@VoxDroid and collaborators).
  • We aim to review PRs within 7 days, but this may vary based on complexity.
  • Ensure your PR addresses a specific issue or feature and includes tests where applicable.
  • Be responsive to feedback and make requested changes promptly.

Questions?

If you have questions or need help, feel free to:

  • Open an issue with the Question template.
  • Contact the maintainer via email: izeno.contact@gmail.com.
  • Check the Support page for additional resources.

Thank you for contributing to Text Extractor! Your efforts help make this project better for everyone.

Developed by VoxDroid
GitHub | Ko-fi