Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

73 lines (49 loc) · 2.54 KB
Raw

Contributing Guidelines

How to Contribute

Thank you for your interest in contributing to this project! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Be sure to include:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Any relevant information about your setup (e.g., operating system, Python version)
  • Screenshots or logs, if applicable

Suggesting Enhancements

We are open to suggestions! If you have an idea for an enhancement, please open an issue on GitHub. Be sure to include:

  • A clear and descriptive title
  • A detailed description of the enhancement
  • Rationale for why the enhancement would be useful
  • Any examples or mockups, if applicable

Pull Requests

We welcome pull requests! To contribute code or documentation, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes in the new branch.
  4. Ensure your code adheres to the project's coding standards.
  5. Update documentation and comments as necessary.
  6. Test your changes thoroughly.
  7. Commit your changes with a descriptive commit message.
  8. Push your changes to your fork.
  9. Open a pull request against the main branch of the original repository.

Code Style

Please follow these guidelines to ensure consistency across the project:

  • Follow PEP 8 for Python code.
  • Use meaningful variable and function names.
  • Write clear and concise comments.
  • Keep functions and methods short and focused.
  • Write tests for your code whenever possible.

Reviewing Pull Requests

When reviewing pull requests, please:

  • Be respectful and constructive in your feedback.
  • Review the code for correctness and readability.
  • Ensure the code adheres to the project's coding standards.
  • Verify that tests pass and that new features are tested.

Documentation

Good documentation is crucial for the usability of the project. Please ensure that:

  • Code is well-documented with comments explaining the purpose of complex logic.
  • Public APIs are documented with docstrings.
  • The README is updated if necessary to reflect changes or new features.

Acknowledgments

Thank you for your interest in contributing to this project. Your contributions are greatly appreciated!

Attribution

This contributing guide is adapted from various open-source projects and tailored to fit the needs of this project.