Contributing

Thank you for considering contributing to facecrop-thumb! Contributions are essential for improving the project and making it better for everyone. Whether you’re fixing a bug, implementing a new feature, or suggesting improvements, your contributions are highly valued.

Before contributing to facecrop-thumb, please take a moment to review the following guidelines to ensure a smooth and efficient collaboration process.

Reporting Issues

If you encounter any bugs, issues, or have feature requests, please submit a detailed report by following these steps:

  1. Check if the issue has already been reported by searching the [issue tracker](https://github.com/mr-vaibh/facecrop-thumb/issues).

  2. If the issue is not already reported, create a new issue and provide the following information: - A clear and descriptive title. - Detailed steps to reproduce the issue. - Expected behavior and actual behavior. - Any relevant error messages or screenshots.

Fixing Bugs and Implementing Features

If you’d like to contribute code to fix a bug or implement a new feature, please follow these steps:

  1. Fork the repository on GitHub.

  2. Create a new branch for your changes.

  3. Implement your changes, adhering to the project’s coding style and guidelines.

  4. Write tests to cover your changes, ensuring that existing tests pass.

  5. Submit a pull request (PR) to the main branch of the repository.

Please include a detailed description of your changes in the pull request, along with any relevant context or reasoning.

Coding Guidelines

To maintain consistency and readability across the codebase, please adhere to the following coding guidelines:

  • Follow PEP 8 style guide for Python code.

  • Use meaningful variable names and comments to enhance code clarity.

  • Write descriptive commit messages that summarize the changes concisely.

Code of Conduct

By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please treat all contributors and users with respect and kindness.

Thank you for your interest in contributing to facecrop-thumb. Your contributions help make the project better for everyone!