Introduction

Thank you for considering contributing to our project! It’s people like you that make essencium such a great library. This document outlines the guidelines and expectations for contributing to our project, ensuring high quality standards and a positive collaborative environment.

What are these guidelines for?

These guidelines serve as a reference for contributors, both new and experienced, to understand the expectations and processes involved in contributing to our project. By following these guidelines, we all can pay respect to the time of the mainainers and contributers managing this project and helping you assessing changes and finalize your pull requests.

What contributions are we looking for?

Essencium is a project that welcomes all kinds of contributions from the community. We welcome various contributions, including bug fixes, feature enhancements, documentation improvements, feature requests, and community engagement.

While we value all contributions, there are certain types that may not align with the project’s goals or development philosophy. Before making a contribution, please ensure it fits within the project’s scope.

Please, don’t use the issue tracker for support questions. Instead, check our communication channels to reach out for help. Also, Stack Overflow is worth considering.

Ground Rules

To maintain a friendly and inclusive community, we enforce a code of conduct. Please review and abide by our Code of Conduct throughout your participation in this project.

Furthermore, by contributing code, you agree to fulfill certain technical responsibilities:

• Ensure cross-platform compatibility for every change that’s accepted. Windows, Mac, Debian & Ubuntu Linux.
• Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
• Keep feature versions as small as possible, preferably one new feature per version.
• When contributing code, make sure to adhere to our coding standards.
• Respect the intellectual property rights of others and other projects.
• Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct.

Code Review Process

Code reviews are an essential part of maintaining code quality and consistency. Our project follows a peer review process, where designated reviewers provide feedback on submitted pull requests. Once a pull request is approved, one of the project maintainers will merge it. Contributors can expect to receive feedback within a reasonable timeframe, and communication regarding the progress of their contributions will be conducted through the pull request comments.

To ensure smooth collaboration, contributors are not granted direct commit access. However, exceptional contributors who consistently provide valuable contributions may be