Thank you for your interest in improving torchHydroNodes! Below are the guidelines for making contributions to the project. Please take a moment to review them before getting started.
There are several ways to help improve the project:
- Bug Reports: If you've encountered behavior that you think is a bug or a missing feature, first check if it's already known. For this, take a look at the repository issues page. If you can't find anything related there, you're welcome to open a new issue.
- Feature Requests: If you have ideas for new features or enhancements, feel free to open a new issue to discuss them.
- Code Contributions: If you're interested in contributing code, please fork the repository, make your changes, and submit a pull request. Make sure to follow the coding style and include tests where applicable.
- Documentation: Improving documentation is always appreciated! If you notice gaps or errors in the code documentation, usage examples, or tutorials, feel free to submit a pull request with your proposed changes.
Even if you don't have the time to contribute directly, there are still ways to support us and show your appreciation:
- Star the Project: Show your support by starring the project on GitHub.
- Spread the Word: Share about torchHydroNodes on social media or in relevant online communities.
- Include in Your Project's README: Consider mentioning torchHydroNodes in your project's README to help others discover it.
- Recommend in Discussions: Mention torchHydroNodes at meetups, conferences, or during discussions with peers to help increase its visibility and adoption.
We appreciate any contributions you make to improve torchHydroNodes. Your support helps make it even more valuable for the community. Thank you!