Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.76 KB

Contributing to Hashing Algorithm

Thank you for your interest in contributing to the Hashing Algorithm project! We welcome contributions from everyone. By participating in this project, you agree to abide by the terms of our code of conduct (if applicable).

How to Contribute

Reporting Bugs

If you encounter any bugs or issues, please open an issue on GitHub. When reporting a bug, please include:

  • A clear and descriptive title.
  • A detailed description of the issue.
  • Steps to reproduce the behavior.
  • Expected behavior vs. actual behavior.
  • Screenshots or logs if applicable.
  • Your operating system and environment details.

Suggesting Enhancements

We appreciate suggestions for new features or improvements. To suggest an enhancement:

  1. Check if the feature has already been requested or implemented.
  2. Open a new issue with a descriptive title and detailed explanation of the proposed feature.
  3. Explain why this feature would be useful to the project.

Pull Request Process

  1. Fork the repository and create your branch from main.
  2. Make your changes and ensure they follow the project's coding standards.
  3. Test your changes to ensure they don't break existing functionality.
  4. Push to your fork and submit a pull request to the main branch.
  5. Provide a clear description of your changes in the pull request description.
  6. Link any relevant issues to your pull request.

Coding Standards

  • Python: Follow PEP 8 style guide.
  • C++: Follow standard C++ best practices. Ensure code is readable and well-documented.
  • Commit Messages: Write clear and concise commit messages.

License

By contributing, you agree that your contributions will be licensed under the MIT License.