Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.5 KB
Raw

Contributing

Thank you for considering contributing to this project! We welcome any contributions that help improve the project, whether they are bug fixes, new features, documentation improvements, or code optimizations.

Code of Conduct

Please read and follow our Code of Conduct before contributing to this project.

How to Contribute

If you encounter any bugs or have feature requests, please open a new issue on the GitHub repository. When reporting an issue, please provide as much detail as possible, including steps to reproduce the problem, expected behavior, and any relevant logs or error messages.

Submitting Pull Requests

If you would like to contribute code changes, please follow these steps:

  • Fork the repository on GitHub.
  • Create a new branch for your changes: git checkout -b my-feature-branch
  • Make your changes and commit them with descriptive commit messages.
  • Push your changes to your forked repository: git push origin my-feature-branch
  • Create a pull request in the main repository, describing your changes in detail.

Pull Request Requirements

  • Be clear and concise.
  • Follow the existing style of the code base.
  • Include comments and documentation as needed.
  • Contain test cases that demonstrate the previous flaw that is now fixed or the newly added feature.
  • Update the documentation if it adds or changes a public API.
  • Be appropriately licensed.

Please ensure that your code adheres to the project's coding standards and conventions. Additionally, make sure to include tests for any new functionality or bug fixes.

Code Style

To ensure consistency throughout the project, we follow these code style guidelines:

Testing

All code contributions should include appropriate test cases to ensure the correctness and stability of the project.

Test cases should cover both positive and negative scenarios.

We follow the principles of Test-Driven Development (TDD) and strive for high code coverage.

Documentation

If your contribution involves changes to the public API or introduces new features, please update the relevant documentation accordingly.

Getting Help

If you need help or have any questions about contributing to this project, please open an issue on the GitHub repository.

Thank you for your interest in contributing to this project!