Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (34 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

57 lines (34 loc) · 2.44 KB

Contributing to data-toolset

Thank you for considering contributing to data-toolset! We appreciate your interest in helping us make this project better.

Before you get started, please take a moment to read the following guidelines to ensure a smooth contribution process.

How to Contribute

Reporting Bugs

If you encounter a bug in the project or have a problem, please open an issue on the GitHub repository. When reporting a bug, be sure to include:

  • A clear and descriptive title.
  • A detailed description of the issue, including steps to reproduce if possible.
  • Your operating system and Python version.

Suggesting Enhancements

We welcome suggestions for enhancements or new features. To suggest an enhancement, please open an issue on the GitHub repository. Be sure to provide:

  • A clear and descriptive title.
  • A detailed description of the enhancement or feature request.

Code Contributions

If you'd like to contribute code to the project, please follow these steps:

  • Fork the repository to your GitHub account.
  • Create a new branch for your contribution: git checkout -b my-contribution.
  • Make your changes and commit them with clear, concise commit messages.
  • Push your changes to your fork: git push origin my-contribution.
  • Create a pull request (PR) against the main branch of the original repository.
  • Ensure that your PR description explains the purpose of the changes and any relevant information.

Our team will review your contribution as soon as possible. Please be patient, as it may take some time for us to provide feedback and merge your changes.

Coding Guidelines

To maintain a consistent codebase, please adhere to the following guidelines when contributing:

  • Follow the PEP 8 style guide for Python code.
  • Write clear and concise code and comments.
  • Ensure that your code is well-documented, especially for public functions and classes.
  • Write unit tests for your code when applicable.

Licensing

By contributing to this project, you agree to license your contributions under the project's license (typically an open-source license). If you are unsure or have questions about the project's licensing, please contact the maintainers.

Thank You! Your help is valuable, and together, we can make this project even better!

If you have any questions or need assistance, please don't hesitate to reach out to the project maintainers through GitHub issues or other available contact methods.

Happy coding! 🐍🚀