Contributing to dominx

Thank you for your interest in contributing to dominx! We welcome contributions from the community to make this project better. By following these guidelines, you can help us maintain a collaborative and productive environment for everyone involved.

How to Contribute

  1. Fork the repository on GitHub.

  2. Clone the forked repository to your local machine.

  3. Create a new branch from the main branch.

  4. Make your changes or add a new feature.

  5. Write unit tests to cover your changes, ensuring good test coverage.

  6. Run the test suite to make sure all tests pass.

  7. Ensure your code adheres to the project’s coding style and guidelines.

  8. Commit your changes with a descriptive commit message.

  9. Push your branch to your forked repository.

  10. Open a pull request (PR) against the main branch of the original repository.

  11. Your PR will be reviewed by the maintainers, and they may suggest changes or improvements.

  12. Once your PR is approved, it will be merged into the main branch, and your contribution will become part of the project!

Code Style

We follow the PEP 8 style guide for Python code. Please make sure your code adheres to these guidelines.

Issue Tracking

If you encounter any bugs or have ideas for improvements, feel free to open an issue on the GitHub repository. Please provide as much detail as possible so that others can easily understand and reproduce the issue.

Feature Requests

We are open to new feature suggestions! If you have an idea for enhancing the library, please open an issue on GitHub to discuss it with the community and maintainers.

Testing

We highly encourage writing unit tests for new features and bug fixes. This helps us maintain a high-quality codebase and prevent regressions. All tests should pass before submitting a pull request.

Code of Conduct

Please note that we have a Code of Conduct, and we expect all contributors to adhere to it. You can find the Code of Conduct in this file.

License

By contributing to this project, you agree that your contributions will be licensed under the license used for this project.

We appreciate your contributions and look forward to making dominx even better with your help!